node-sass-yaml-importer

Node.js based YAML importer for Sass

This package makes the @import/@use rules in Sass work with YAML files through custom importers for the current as well as the legacy Sass JavaScript API.

Since YAML is a superset of JSON, this importer can also be used to import JSON files.

Usage in SCSS Code

Given the following colors.yml file:

primary: blue
secondary: red

The importer allows your Sass file in the same folder to do this:

@import 'colors.yml';

.some-class {
  background: $primary;
}

Note that @import is somewhat deprecated and you should use @use instead:

@use 'colors.yml';

.some-class {
  // Data is automatically namespaced:
  background: colors.$primary;
}

To achieve the same behavior as with @import, you can change the namespace to *:

@use 'colors.yml' as *;

.some-class {
  // Colors are no longer namespaced:
  background: $primary;
}

Importing Strings

As YAML values don't map directly to Sass's data types, a common source of confusion is how to handle strings. While Sass allows strings to be both quoted and unqouted, strings containing spaces, commas and/or other special characters have to be wrapped in quotes.

The importer will automatically add quotes around all strings that are not valid unquoted strings or hex colors (and that are not already quoted, of course):

Map Keys

Map keys are always quoted by the importer:

# colors.yml
colors:
  red: '#f00'

@use 'colors.yml' as *;

:root {
  // This does not work:
  color: map-get($colors, red);

  // Do this instead:
  color: map-get($colors, 'red');
}

Resolving Paths

The importer tries to stick to the same path resolution logic as Sass itself. This means that it tries to interpret import requests as (relative) file system paths:

// In /path/to/some-file.scss
@use 'config/colors.yml'; // Resolves to /path/to/config/colors.yml

If no according file can be found, further resolving depends on the kind of importer you're using:

• When using the sass-loader factories, the importer will try to resolve paths the same way webpack does. This means that you can use npm package names or webpack aliases to reference your YAML files.
• When using the Sass compiler directly with the legacy Sass JavaScript API, the importer will try to find the requested file inside the configured includedPaths.
• In contrast, using the Sass compiler directly with the modern Sass JavaScript API will not consider the loadPaths option, as the modern API purposefully does not share Sass options with importers.

Setting up the Importer

[!NOTE]

Some notes on the code samples below:

1. The examples make use of ES modules, but the importer will work in CommonJS environments just fine.
2. Examples are using the sass package. However, the same code should work equally well with sass-embedded. The legacy API examples should even work with node-sass (although this is no longer tested since Node Sass has been deprecated).

Sass with Modern JavaScript API

import * as sass from 'sass'
import { yamlImporter } from 'node-sass-yaml-importer'

sass.compile('some-file.scss', {
  importers: [yamlImporter],
})

Sass with Legacy JavaScript API

import * as sass from 'sass'
import { legacyYamlImporter } from 'node-sass-yaml-importer'

sass.renderSync({
  file: 'some-file.scss',
  importer: [legacyYamlImporter],
})

sass-loader (for webpack/rspack)

This package exposes the createSassLoaderYamlImporter/createSassLoaderLegacyYamlImporter factory functions to create importers that work well with sass-loader.

While you could just use the importers directly (as documented in the previous section), the sass-loader-specific factory functions enable you to use webpack's request resolution (like pointing to npm packages or aliases) to reference your YAML files. Learn more about this in the Resolving Paths section.

To use the importer factory with sass-loader, you need to pass a function to its sassOptions option to get access to the loaderContext object. This object then needs to be passed to the importer factory:

// webpack.config.js / rspack.config.js

import { createSassLoaderYamlImporter } from 'node-sass-yaml-importer'

export default {
  // ...
  {
    loader: 'sass-loader',
    options: {
      sassOptions: loaderContext => ({
        return {
          importers: [
            createSassLoaderYamlImporter(loaderContext)
          ],
        }
      },
    },
  },
  // ...
}

[!NOTE]

While the code above uses the importer for the modern Sass JavaScript API, you can also create a legacy importer through the createSassLoaderLegacyYamlImporter factory instead. In that case, make sure to also adjust the api option accordingly, if needed.

Credit

The initial implementation of this importer was based on the node-sass-json-importer package.