README.md

sass-resources-loader

This loader will load your Sass resources into every required Sass module. So you can use your shared variables, mixins and functions across all Sass styles without manually loading them in each file.

This project is sponsored by the software consulting firm ShakaCode, creator of the React on Rails Gem.

ShakaCode Support

ShakaCode focuses on helping Ruby on Rails teams use React and Webpack better. We can upgrade your project and improve your development and customer experiences, allowing you to focus on building new features or fixing bugs instead.

For an overview of working with us, see our Client Engagement Model article and how we bill for time.

We also specialize in helping development teams lower infrastructure and CI costs. Check out our project Control Plane Flow, which can allow you to get the ease of Heroku with the power of Kubernetes and big cost savings.

If you think ShakaCode can help your project, click here to book a call with Justin Gordon, the creator of React on Rails and Shakapacker.

Here's a testimonial of how ShakaCode can help from Florian Gößler of Blinkist, January 2, 2023:

Hey Justin 👋

I just wanted to let you know that we today shipped the webpacker to shakapacker upgrades and it all seems to be running smoothly! Thanks again for all your support and your teams work! 😍

On top of your work, it was now also very easy for me to upgrade Tailwind and include our external node_module based web component library which we were using for our other (more modern) apps already. That work is going to be shipped later this week though as we are polishing the last bits of it. 😉

Have a great 2023 and maybe we get to work together again later in the year! 🙌

Read the full review here.

---

Features

• Made to work with CSS Modules!
• This loader is not limited to Sass resources. It supposedly works with less, post-css, etc. per issue 31.
• Supports Webpack 5
• Supports Sass @use syntax. You must use Dart Sass (sass, not node-sass npm package). See the hoistUseStatements option.

---

Installation

Get it via npm:

npm install sass-resources-loader

Usage

Create your file (or files) with resources, which are snippets of Sass that you want available to places like CSS modules Sass:

/* resources.scss */

$section-width: 700px;

@mixin section-mixin {
  margin: 0 auto;
  width: $section-width;
}

Options

Name	Type	Default	Description
resources	{String|String[]}	undefined	Resources to include in files
hoistUseStatements	{Boolean}	false	If true, entry file @use imports will be hoisted. This means that @use statements will go above the inclusion of resources.

Option Examples

resources

Specify resources, contents of which will be prepended to each file.

For example, if variable $my-variable: #fff is in file example/a.scss, specify this file as a resource in your webpack.config.js

{
    loader: 'sass-resources-loader',
    options: {
        resources: 'example/a.scss'
    }
}

to prepend this variable

// Entry file

$my-variable: #fff;

// Entry file's content go here

hoistUseStatements

Tells the compiler if an existing @use statement is found in entry file, it should be hoisted to the top. The reason is that @use must go before most other declarations, except variable declarations, per the docs.

If our entry file has the following content

// Entry file
@use 'my/definitions/file';
@use 'my/other/definitions/file';

// Entry file's contents go here

and our resource file contains this

$my-variable: #fff;

@mixin some-mixin {
    color: #000;
}

then the output, with hoistUseStatements set to true, would be the following. Note that the @use statements are above the inclusion of resources.

// Entry file
@use 'my/definitions/file';
@use 'my/other/definitions/file';

// Resources
$my-variable: #fff;

@mixin some-mixin {
    color: #000;
}

// Rest of entry file's content goes here

You can also use this multi-line syntax:

@use 'config' with (
    $text-color: #FAFAFA
);

See ./test/scss/hoist-multiline.scss for an example.

As mentioned in the docs for Sass @use, you don't need to hoist if your "resources" only contains variable definitions.

If you get the error:

SassError: @use rules must be written before any other rules.

then you need to use the hoistUseStatements: true option.

Tips

• Do not include anything that will be actually rendered in CSS, because it will be added to every imported Sass file.
• Avoid using Sass import rules inside resources files as it slows down incremental builds. Add imported files directly in sassResources array in webpack config instead. If you concerned about location of your resources index, you might want to check out the solution outlined in this comment.
• If you still want to use Sass import rules make sure your paths are relative to the file they defined in (basically, your file with resources), except the ones started with ~ (~ is resolved to node_modules folder).

Apply loader in webpack config (v1.x.x & v2.x.x are supported) and provide path to the file with resources:

/* Webpack@2: webpack.config.js */

module: {
  rules: [
    // Apply loader
    {
      test: /\.scss$/,
      use: [
        'style-loader',
        'css-loader',
        'postcss-loader',
        'sass-loader',
        {
          loader: 'sass-resources-loader',
          options: {
            // Provide path to the file with resources
            resources: './path/to/resources.scss',

            // Or array of paths
            resources: [
              './path/to/vars.scss',
              './path/to/mixins.scss',
              './path/to/functions.scss'
            ]
          },
        },
      ],
    },
  ],
},

/* Webpack@1: webpack.config.js */

module: {
  loaders: [
    // Apply loader
    { test: /\.scss$/, loader: 'style!css!sass!sass-resources' },
  ],
},

// Provide path to the file with resources
sassResources: './path/to/resources.scss',

// Or array of paths
sassResources: ['./path/to/vars.scss', './path/to/mixins.scss'],

NOTE: If webpackConfig.context is not defined, process.cwd() will be used to resolve files with resource.

Now you can use these resources without manually loading them:

/* component.scss */

.section {
  @include section-mixin; // <--- `section-mixin` is defined here
}

import React from 'react';
import css from './component.scss';

// ...

render() {
  return (
    <div className={css.section} />
  );
}

Glob pattern matching

You can specify glob patterns to match all of your files in the same directory.

// Specify a single path
resources: './path/to/resources/**/*.scss', // will match all files in folder and subdirectories
// or an array of paths
resources: [ './path/to/resources/**/*.scss', './path/to/another/**/*.scss' ]

Note that sass-resources-loader will resolve your files in order. If you want your variables to be accessed across all of your mixins you should specify them in first place.

resources: [ './path/to/variables/vars.scss', './path/to/mixins/**/*.scss' ]

Examples and Related Libraries

• react-webpack-rails-tutorial, live example at www.reactrails.com.
• bootstrap-loader

Example of Webpack 4 Config for Vue

  module: {
    rules: [
      {
        test: /\.vue$/,
        use: 'vue-loader'
      },
      {
        test: /\.css$/,
        use: [
          { loader: 'vue-style-loader' },
          { loader: 'css-loader', options: { sourceMap: true } },
        ]
      },
      {
        test: /\.scss$/,
        use: [
          { loader: 'vue-style-loader' },
          { loader: 'css-loader', options: { sourceMap: true } },
          { loader: 'sass-loader', options: { sourceMap: true } },
          { loader: 'sass-resources-loader',
            options: {
              sourceMap: true,
              resources: [
                resolveFromRootDir('src/styles/variables.scss'),
              ]
            }
          }
        ]
      }
    ]
  }

VueJS webpack template(vue-cli@2)

If you wish to use this loader in the VueJS Webpack template you need to add the following code in build/utils.js after line 42 :

if (loader === 'sass') {
  loaders.push({
    loader: 'sass-resources-loader',
    options: {
      resources: 'path/to/your/file.scss',
    },
  });
}

VueJS webpack template(vue-cli@3)

If you are using vue-cli@3, you need to create a vue.config.js file in your project root (next to package.json). Then, add the following code:

// vue.config.js
module.exports = {
  chainWebpack: config => {
    const oneOfsMap = config.module.rule('scss').oneOfs.store
    oneOfsMap.forEach(item => {
      item
        .use('sass-resources-loader')
        .loader('sass-resources-loader')
        .options({
          // Provide path to the file with resources
          resources: './path/to/resources.scss',

          // Or array of paths
          resources: ['./path/to/vars.scss', './path/to/mixins.scss', './path/to/functions.scss']
        })
        .end()
    })
  }
}

Contributing

This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

See Contributing to get started.

License

sass-resources-loader is available under MIT. See LICENSE for more details.

Supporters

The following companies support our open source projects, and ShakaCode uses their products!