sass-loader 6.0.2

Sass loader for webpack

Homepage: https://github.com/jtangelder/sass-loader

Platform: npm

Language: HTML

License: MIT

Keywords: sass, libsass, webpack, loader

View on registry: https://www.npmjs.com/package/sass-loader

Direct download link: https://registry.npmjs.org/sass-loader/-/sass-loader-6.0.2.tgz

Install: npm install [email protected]


npm deps test

sass-loader

Compiles Sass to CSS.
Use the css-loader or the raw-loader to turn it into a JS module and the ExtractTextPlugin to extract it into a separate file.

Looking for the webpack 1 loader? Check out the archive/webpack-1 branch.

Install

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

The sass-loader requires node-sass and webpack as peerDependency. Thus you are able to control the versions accurately.

Examples

Chain the sass-loader with the css-loader and the style-loader to immediately apply all styles to the DOM.

// webpack.config.js
module.exports = {
    ...
    module: {
        rules: [{
            test: /\.scss$/,
            use: [{
                loader: "style-loader" // creates style nodes from JS strings
            }, {
                loader: "css-loader" // translates CSS into CommonJS
            }, {
                loader: "sass-loader" // compiles Sass to CSS
            }]
        }]
    }
};

You can also pass options directly to node-sass by specifying an options property like this:

// webpack.config.js
module.exports = {
    ...
    module: {
        rules: [{
            test: /\.scss$/,
            use: [{
                loader: "style-loader"
            }, {
                loader: "css-loader"
            }, {
                loader: "sass-loader",
                options: {
                    includePaths: ["absolute/path/a", "absolute/path/b"]
                }
            }]
        }]
    }
};

See node-sass for all available Sass options.

In production

Usually, it's recommended to extract the stylesheets into a dedicated file in production using the ExtractTextPlugin. This way your styles are not dependent on JavaScript:

const ExtractTextPlugin = require("extract-text-webpack-plugin");

const extractSass = new ExtractTextPlugin({
    filename: "[name].[contenthash].css",
    disable: process.env.NODE_ENV === "development"
});

module.exports = {
    ...
    module: {
        rules: [{
            test: /\.scss$/,
            loader: extractSass.extract({
                loader: [{
                    loader: "css-loader"
                }, {
                    loader: "sass-loader"
                }],
                // use style-loader in development
                fallbackLoader: "style-loader"
            })
        }]
    },
    plugins: [
        extractSass
    ]
};

Usage

Imports

webpack provides an advanced mechanism to resolve files. The sass-loader uses node-sass' 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/css/bootstrap";

It's important to only prepend it with ~, because ~/ resolves to the home directory. 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";

Environment variables

If you want to prepend Sass code before the actual entry file, you can simply set the data option. 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:

{
    loader: "sass-loader",
    options: {
        data: "$env: " + process.env.NODE_ENV + ";"
    }
}

Problems with url(...)

Since Sass/libsass does not provide url rewriting, all linked assets must be relative to the output.

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

More likely you will be disrupted by this second issue. It is natural to expect relative references to be resolved against the .scss file in which they are specified (like in regular .css files). Thankfully there are a two solutions to this problem:

Extracting stylesheets

Bundling CSS with webpack has some nice advantages like referencing images and fonts with hashed urls or hot module replacement in development. In production, on the other hand, it's not a good idea to apply your stylesheets depending on JS execution. Rendering may be delayed or even a FOUC might be visible. Thus it's often still better to have them as separate files in your final production build.

There are two possibilties to extract a stylesheet from the bundle:

Source maps

To enable CSS source maps, you'll need to pass the sourceMap option to the sass-loader and the css-loader. Your webpack.config.js should look like this:

module.exports = {
    ...
    devtool: "source-map", // any "source-map"-like devtool is possible
    module: {
        rules: [{
            test: /\.scss$/,
            use: [{
                loader: "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.

Maintainers


Johannes Ewald

Jorik Tangelder

Kiran

License

MIT


Dependencies Requirements Latest Stable Latest Release Licenses
async ^2.1.5 2.1.5 2.1.5 MIT
clone-deep ^0.2.4 0.2.4 0.2.4 MIT
loader-utils ^1.0.1 1.0.2 1.0.2 MIT
lodash.tail ^4.1.1 4.1.1 4.1.1 MIT
pify ^2.3.0 2.3.0 2.3.0 MIT
Explore the resolved dependency tree for sass-loader 6.0.2
Development Dependencies Requirements Latest Stable Latest Release Licenses
bootstrap-sass ^3.3.5 3.3.7 3.3.7 MIT
css-loader ^0.26.1 0.26.2 0.26.2 MIT
eslint ^3.16.0 3.16.1 3.16.1 MIT
eslint-config-peerigon ^9.0.0 9.0.0 9.0.0 Unlicense
eslint-plugin-jsdoc ^2.4.0 2.4.0 2.4.0 BSD-3-Clause
file-loader ^0.10.0 0.10.0 0.10.0 MIT
mocha ^3.0.2 3.2.0 3.2.0 MIT
node-sass ^4.5.0 4.5.0 4.5.0 MIT
raw-loader ^0.5.1 0.5.1 0.5.1 MIT
should ^11.2.0 11.2.0 11.2.0 MIT
style-loader ^0.13.1 0.13.2 0.13.2 MIT
webpack ^2.2.1 2.2.1 2.2.1 MIT
webpack-dev-server ^2.4.1 2.4.1 2.4.1 MIT
webpack-merge ^3.0.0 3.0.0 3.0.0 MIT
Explore the resolved development dependency tree for sass-loader 6.0.2

Releases

  • 6.0.2 - February 21, 2017 15:34
  • 6.0.1 - February 17, 2017 10:56
  • 6.0.0 - February 13, 2017 19:40
  • 5.0.1 - February 08, 2017 15:36
  • 5.0.0 - February 07, 2017 01:14
  • 4.1.1 - December 21, 2016 11:17
  • 4.1.0 - December 14, 2016 18:07
  • 4.0.2 - September 07, 2016 12:18
  • 4.0.1 - September 01, 2016 12:54
  • 4.0.0 - June 27, 2016 09:03
See all 38 releases

Project Statistics

SourceRank 26
Dependencies 5
Dependent projects 3.69K
Dependent repositories 22.2K
Total releases 38
Latest release
First release
Stars 1.28K
Forks 176
Watchers 20
Contributors 35
Repo Size: 301 KB

Top Contributors See all

Johannes Ewald Jorik Tangelder Kiran Jeremy Stucki Mr. C Jorrit Schippers Sergey Rubanov Justin Gordon Conrad Pankoff Tim Finley Ivan Nikolić Matt Lewis Stuart Robson Jaeho Lee Christoph Krämer Patrick Mowrer Ben Holloway Lewis Barnes Micah Martin Clinton Blackburn

Something wrong with this page? Make a suggestion

Export .ABOUT file for this library

Last synced: 2017-02-21 15:52:59 UTC

Login to resync this project