sass-render-errors v2.0.3

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.

Undefined functions

Sass currently doesn’t check for undefined functions. This module has additional renderer which tries to guess which functions are undefined by comparing list of known CSS functions with functions defined in file.

This renderer is available as named export undefinedFunctions.

Install

npm install sass-render-errors --save

Usage

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

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

index.scss

@use 'sass:color';

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

API

sassRenderErrors(sass, options)

Creates Sass renderer. All methods return Promise, but internally use original Sass compile methods.

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.

options

Type: object

For undefined functions:

renderer[compile|compileAsync|compileString|compileStringAsync](options)

Returns: Promise<SassRenderError[]>

Promise with array of errors and deprecations.

If input contains multiple errors, only first one is shown. If you’re using undefined function renderer, all errors are always visible.

All deprecations are always visible.

Each array entry is object which contains following properties:

options

Type: sass.Options|sass.StringOptions

compile and compileAsync methods take [sass.Options](https://sass-lang.com/documentation/js-api/interfaces/options/).
compileString and compileStringAsync methods take [sass.StringOptions](https://sass-lang.com/documentation/js-api/interfaces/stringoptions/).

License

MIT © [Ivan Nikolić](http://ivannikolic.com)