JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 882
  • Score
    100M100P100Q142810F
  • License MIT

Get Sass render errors and deprecations.

Package Exports

  • sass-render-errors
  • sass-render-errors/package.json

Readme

sass-render-errors

Build Status

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.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[]>

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:

Property Type Description
file string Full path to file or stdin with error or deprecation.
message string Error or deprecation message.
source.start.column number Pattern start column.
source.start.line number Pattern start line.
source.end.column number Pattern end column.
source.end.line number Pattern end line.
source.pattern string Error or deprecation code or pattern of code.
type string Can be either error or deprecation.

options

Type: object

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

License

MIT © Ivan Nikolić