sass-render-errors

Get Sass render errors and deprecations.

Currently there’s no Sass API which reports errors and deprecations in machine readable format (e.g. JSON-like data). This module parses Sass render output and provides render information for easier usage in linters and similar tools.

Install

npm install sass-render-errors --save

Usage

import sassRenderErrors from 'sass-render-errors';
import sass from 'sass';

(async () => {
    const renderer = sassRenderErrors(sass);
    const result = await renderer.render({ file: './index.scss' });
    console.log(result);
    /*[
        {
            file: '<full path>/index.scss',
            message: 'Passing a number (1) to color.invert() is deprecated. Recommendation: invert(1).',
            source: {
                end: {
                    column: 24,
                    line: 4
                },
                pattern: 'color.invert(1)',
                start: {
                    column: 9,
                    line: 4
                }
            },
            type: 'deprecation'
        }
    ]*/
})();

index.scss

@use 'sass:color';

.becky {
    color: color.invert(1);
}

API

sassRenderErrors(sass)

Creates Sass renderer with methods render and renderSync. Both methods return Promise, but internally use original Sass rendering methods. This way you can leverage faster rendering without using Fibers.

sass

Sass module reference. Only Dart Sass is supported.

Sass is injected as dependancy because each version has different set of errors and deprecations and you should get results for Sass version your application uses.

renderer[render|renderSync]([options])

Returns: Promise<SassRenderError[]>

options

Type: object

Sass options. For detailed explanation see node-sass options reference.

License

MIT © Ivan Nikolić