webpack-contrib/sass-loader


Compiles Sass to CSS

License: MIT

Language: JavaScript

Keywords: dart-sass, loader, node-sass, sass, scss, webpack, webpack-loader


npm node deps tests coverage chat size

sass-loader

Loads a Sass/SCSS file and compiles it to CSS.

Getting Started

To begin, you'll need to install sass-loader:

npm install sass-loader node-sass webpack --save-dev

The sass-loader requires you to install either Node Sass or Dart Sass on your own (more documentation you can find below). This allows you to control the versions of all your dependencies, and to choose which Sass implementation to use.

Chain the sass-loader with the css-loader and the style-loader to immediately apply all styles to the DOM or the mini-css-extract-plugin to extract it into a separate file.

Then add the loader to your webpack config. For example:

file.js

import style from './style.scss';

file.scss

$body-color: red;

body {
  color: $body-color;
}

webpack.config.js

module.exports = {
  module: {
    rules: [
      {
        test: /\.s[ac]ss$/i,
        use: [
          // Creates `style` nodes from JS strings
          'style-loader',
          // Translates CSS into CommonJS
          'css-loader',
          // Compiles Sass to CSS
          'sass-loader',
        ],
      },
    ],
  },
};

And run webpack via your preferred method.

Resolving import at-rules

The webpack provides an advanced mechanism to resolve files.

The sass-loader uses Sass's custom importer feature to pass all queries to the webpack resolving engine. Thus you can import your Sass modules from node_modules. Just prepend them with a ~ to tell webpack that this is not a relative import:

@import '~bootstrap';

It's important to only prepend it with ~, because ~/ resolves to the home directory. The webpack needs to distinguish between bootstrap and ~bootstrap because CSS and Sass files have no special syntax for importing relative files. Writing @import "file" is the same as @import "./file";

Problems with url(...)

Since sass implementations don't provide url rewriting, all linked assets must be relative to the output.

  • If you pass the generated CSS on to the css-loader, all urls must be relative to the entry-file (e.g. main.scss).
  • If you're just generating CSS without passing it to the css-loader, it must be relative to your web root.

You will be disrupted by this first issue. It is natural to expect relative references to be resolved against the .sass/.scss file in which they are specified (like in regular .css files).

Thankfully there are a two solutions to this problem:

  • Add the missing url rewriting using the resolve-url-loader. Place it before the sass-loader in the loader chain.
  • Library authors usually provide a variable to modify the asset path. bootstrap-sass for example has an $icon-font-path.

Options

implementation

The special implementation option determines which implementation of Sass to use.

By default the loader resolve the implementation based on your dependencies. Just add required implementation to package.json (node-sass or sass package) and install dependencies.

Example where the sass-loader loader uses the sass (dart-sass) implementation:

package.json

{
  "devDependencies": {
    "sass-loader": "^7.2.0",
    "sass": "^1.22.10"
  }
}

Example where the sass-loader loader uses the node-sass implementation:

package.json

{
  "devDependencies": {
    "sass-loader": "^7.2.0",
    "node-sass": "^4.0.0"
  }
}

Beware the situation when node-sass and sass was installed, by default the sass-loader prefers node-sass, to avoid this situation use the implementation option.

It takes either node-sass or sass (Dart Sass) module.

For example, to use Dart Sass, you'd pass:

module.exports = {
  module: {
    rules: [
      {
        test: /\.s[ac]ss$/i,
        use: [
          'style-loader',
          'css-loader',
          {
            loader: 'sass-loader',
            options: {
              // Prefer `dart-sass`
              implementation: require('sass'),
            },
          },
        ],
      },
    ],
  },
};

Note that when using sass (Dart Sass), synchronous compilation is twice as fast as asynchronous compilation by default, due to the overhead of asynchronous callbacks. To avoid this overhead, you can use the fibers package to call asynchronous importers from the synchronous code path.

We automatically inject the fibers package (setup sassOptions.fiber) if is possible (i.e. you need install the fibers package).

package.json

{
  "devDependencies": {
    "sass-loader": "^7.2.0",
    "sass": "^1.22.10",
    "fibers": "^4.0.1"
  }
}

You can disable automatically inject the fibers package pass the false value for the sassOptions.fiber option.

webpack.config.js

module.exports = {
  module: {
    rules: [
      {
        test: /\.s[ac]ss$/i,
        use: [
          'style-loader',
          'css-loader',
          {
            loader: 'sass-loader',
            options: {
              implementation: require('sass'),
              sassOptions: {
                fiber: false,
              },
            },
          },
        ],
      },
    ],
  },
};

Also you can pass own the fiber value using this code:

webpack.config.js

module.exports = {
  module: {
    rules: [
      {
        test: /\.s[ac]ss$/i,
        use: [
          'style-loader',
          'css-loader',
          {
            loader: 'sass-loader',
            options: {
              implementation: require('sass'),
              sassOptions: {
                fiber: require('fibers'),
              },
            },
          },
        ],
      },
    ],
  },
};

sassOptions

Type: Object|Function

Options for Node Sass or Dart Sass implementation.

ℹ️ The indentedSyntax option has true value for the sass extension.

ℹ️ Options such as file and outFile are unavailable.

ℹ We recommend don't use sourceMapContents, sourceMapEmbed, sourceMapRoot options because loader automatically setup this options.

There is a slight difference between the node-sass and sass (Dart Sass) options. We recommend look documentation before used them:

Object

Setups option as object for sass implementation.

webpack.config.js

module.exports = {
  module: {
    rules: [
      {
        test: /\.s[ac]ss$/i,
        use: [
          'style-loader',
          'css-loader',
          {
            loader: 'sass-loader',
            options: {
              sassOptions: {
                indentWidth: 4,
                includePaths: ['absolute/path/a', 'absolute/path/b'],
              },
            },
          },
        ],
      },
    ],
  },
};

Function

Allows setup difference options based on loader context.

module.exports = {
  module: {
    rules: [
      {
        test: /\.s[ac]ss$/i,
        use: [
          'style-loader',
          'css-loader',
          {
            loader: 'sass-loader',
            options: {
              sassOptions: (loaderContext) => {
                // More information about available properties https://webpack.js.org/api/loaders/
                const { resourcePath, rootContext } = loaderContext;
                const relativePath = path.relative(rootContext, resourcePath);

                if (relativePath === 'styles/foo.scss') {
                  return {
                    includePaths: ['absolute/path/c', 'absolute/path/d'],
                  };
                }

                return {
                  includePaths: ['absolute/path/a', 'absolute/path/b'],
                };
              },
            },
          },
        ],
      },
    ],
  },
};

prependData

Type: String|Function Default: undefined

Prepends Sass/SCSS code before the actual entry file. In this case, the sass-loader will not override the data option but just append the entry's content.

This is especially useful when some of your Sass variables depend on the environment:

ℹ Since you're injecting code, this will break the source mappings in your entry file. Often there's a simpler solution than this, like multiple Sass entry files.

String

module.exports = {
  module: {
    rules: [
      {
        test: /\.s[ac]ss$/i,
        use: [
          'style-loader',
          'css-loader',
          {
            loader: 'sass-loader',
            options: {
              prependData: '$env: ' + process.env.NODE_ENV + ';',
            },
          },
        ],
      },
    ],
  },
};

Function

module.exports = {
  module: {
    rules: [
      {
        test: /\.s[ac]ss$/i,
        use: [
          'style-loader',
          'css-loader',
          {
            loader: 'sass-loader',
            options: {
              prependData: (loaderContext) => {
                // More information about available properties https://webpack.js.org/api/loaders/
                const { resourcePath, rootContext } = loaderContext;
                const relativePath = path.relative(rootContext, resourcePath);

                if (relativePath === 'styles/foo.scss') {
                  return '$value: 100px;';
                }

                return '$value: 200px;';
              },
            },
          },
        ],
      },
    ],
  },
};

sourceMap

Type: Boolean Default: depends on the compiler.devtool value

Enables/Disables generation of source maps.

By default generation of source maps depends on the devtool option, all values enable source map generation except eval and false value.

webpack.config.js

module.exports = {
  module: {
    rules: [
      {
        test: /\.s[ac]ss$/i,
        use: [
          'style-loader',
          {
            loader: 'css-loader',
            options: {
              sourceMap: true,
            },
          },
          {
            loader: 'sass-loader',
            options: {
              sourceMap: true,
            },
          },
        ],
      },
    ],
  },
};

ℹ In some rare case node-sass can output invalid source maps (it is node-sass bug), to avoid try to update node-sass to latest version or you can try to set the outputStyle option to compressed value.

webpackImporter

Type: Boolean Default: true

Enables/Disables default webpack importer.

This can improve performance in some cases. Use it with caution because aliases and @import at-rules starts with ~ will not work, but you can pass own importer to solve this (see importer docs).

webpack.config.js

module.exports = {
  module: {
    rules: [
      {
        test: /\.s[ac]ss$/i,
        use: [
          'style-loader',
          'css-loader',
          {
            loader: 'sass-loader',
            options: {
              webpackImporter: false,
            },
          },
        ],
      },
    ],
  },
};

Examples

Extracts CSS into separate files

For production builds it's recommended to extract the CSS from your bundle being able to use parallel loading of CSS/JS resources later on.

There are two possibilities to extract a style sheet from the bundle:

webpack.config.js

const MiniCssExtractPlugin = require('mini-css-extract-plugin');

module.exports = {
  module: {
    rules: [
      {
        test: /\.s[ac]ss$/i,
        use: [
          // fallback to style-loader in development
          process.env.NODE_ENV !== 'production'
            ? 'style-loader'
            : MiniCssExtractPlugin.loader,
          'css-loader',
          'sass-loader',
        ],
      },
    ],
  },
  plugins: [
    new MiniCssExtractPlugin({
      // Options similar to the same options in webpackOptions.output
      // both options are optional
      filename: '[name].css',
      chunkFilename: '[id].css',
    }),
  ],
};

Source maps

Enables/Disables generation of source maps.

To enable CSS source maps, you'll need to pass the sourceMap option to the sass-loader and the css-loader.

webpack.config.js

module.exports = {
  devtool: 'source-map', // any "source-map"-like devtool is possible
  module: {
    rules: [
      {
        test: /\.scss$/,
        use: [
          'style-loader',
          {
            loader: 'css-loader',
            options: {
              sourceMap: true,
            },
          },
          {
            loader: 'sass-loader',
            options: {
              sourceMap: true,
            },
          },
        ],
      },
    ],
  },
};

If you want to edit the original Sass files inside Chrome, there's a good blog post. Checkout test/sourceMap for a running example.

Contributing

Please take a moment to read our contributing guidelines if you haven't yet done so.

CONTRIBUTING

License

MIT

Project Statistics

Sourcerank 21
Repository Size 1.61 MB
Stars 3,175
Forks 324
Watchers 41
Open issues 5
Dependencies 1,079
Contributors 63
Tags 44
Created
Last updated
Last pushed

Top Contributors See all

Johannes Ewald Evilebot Tnawi Jorik Tangelder Joshua Wiens Kiran Jeremy Stucki Jorrit Schippers Mr. C Sergey Rubanov James George Roman Vanesyan Michael Ciniawsky Simon Legner Justin Gordon Rhys van der Waerden Conrad Pankoff Fahad Ibnay Heylaal Thai Pangsakulyanont Joe Lencioni Adam DiCarlo

Packages Referencing this Repo

@researchgate/sass-loader
Sass loader for webpack
Latest release 4.1.1 - Published - 3.18K stars
harry-sass-loader
Sass loader for webpack
Latest release 0.2.0 - Published - 3.18K stars
@gyugyu/sass-loader
Sass loader for webpack
Latest release 8.0.0 - Published - 3.18K stars
sass-loader
Sass loader for webpack
Latest release 8.0.0 - Updated - 3.18K stars
@davidqhr/sass-loader
Sass loader for webpack
Latest release 7.1.2 - Published - 3.18K stars
fis-msprd-sass-loader_4_1_1
Sass loader for webpack
Latest release 4.1.1 - Published - 3.18K stars
sass-loader-vendor
Sass loader for webpack
Latest release 6.0.6 - Published - 3.18K stars
sass2-loader
Sass loader for webpack
Latest release 6.0.7 - Published - 3.18K stars
sass-vendor-loader
Sass loader for webpack
Latest release 6.0.6 - Published - 3.18K stars
sass-x-loader
Sass loader for webpack and node-sass-bindings
Latest release 3.2.4 - Updated - 3.18K stars

Recent Tags See all

v8.0.0 August 29, 2019
v7.3.1 August 20, 2019
v7.3.0 August 20, 2019
v7.2.0 August 08, 2019
v7.1.0 August 01, 2018
v7.0.3 June 05, 2018
v7.0.2 June 02, 2018
v7.0.1 April 13, 2018
v7.0.0 April 13, 2018
v6.0.7 March 03, 2018
v6.0.6 June 14, 2017
v6.0.5 May 10, 2017
v6.0.4 May 09, 2017
v6.0.3 March 08, 2017
v6.0.2 February 21, 2017

Interesting Forks See all

limscoder/themed-sass-loader
SASS loader for Webpack
HTML - Last pushed - 4 stars - 2 forks
OpenLearningNet/sass-loader
SASS loader for Webpack
JavaScript - MIT - Last pushed - 1 stars
joy-web/sass-loader
Sass loader for webpack. Compiles Sass to CSS.
HTML - MIT - Last pushed - 1 stars - 1 forks
shadowwzw/sass2-loader
Sass loader for webpack. Compiles Sass to CSS.
HTML - Last pushed - 1 stars
d--j/eyeglass-loader
Eyeglass loader for Webpack
HTML - Updated - 1 stars - 1 forks

Something wrong with this page? Make a suggestion

Last synced: 2019-08-30 01:43:46 UTC

Login to resync this repository