SASS resources loader for Webpack
npm install sass-resources-loaderThis 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.
* 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 4
* Supports Sass @use syntax. You must use Dart Sass (sass, not node-sass npm package). See the hoistUseStatements option.
#### About
This project is maintained by the software consulting firm ShakaCode. We focus on Ruby on Rails applications with React front-ends, often using TypeScript or ReasonML. We also build Gatsby sites. See our recent work for examples of what we do. Feel free to contact Justin Gordon, justin@shakacode.com, for more information.
Slack Room: Click for a Slack invite.
---------------
Get it via npm:
``bash`
npm install sass-resources-loader
Create your file (or files) with resources, which are snippets of Sass that you want available to places like CSS modules Sass:
`scss
/ resources.scss /
$section-width: 700px;
@mixin section-mixin {
margin: 0 auto;
width: $section-width;
}
`
| 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 the @use statements will go above the inclusion of resources. |
#### resources
Specify resources, contents of these will be prepended to each file.
If file example/a.scss has content of $my-variable: #fff, we could do this`js``
{
loader: 'sass-resources-loader',
options: {
resources: 'example/a.scss'
}
}
This would output the following:
`scss
// Entry file
$my-variable: #fff;
// Entry file's contents go here
`
#### hoistUseStatements
Tells the compiler if an existing statement is found in entry file, it should be hoisted to the top.@use
The reason is that must go before most other declarations, except variable declarations, per the docs.
If our entry file has the following content
`scss
// Entry file
@use 'my/definitions/file';
@use 'my/other/definitions/file';
// Entry file's contents go here
`
and our resource file contains thisscss
$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.`scss
// 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:
`scss`
@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.
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:`js
/ 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
is not defined, process.cwd() will be used to resolve files with resource.Now you can use these resources without manually loading them:
`scss
/ component.scss /.section {
@include section-mixin; // <---
section-mixin is defined here
}
`js
import React from 'react';
import css from './component.scss';// ...
render() {
return (
);
}
`$3
You can specify glob patterns to match your all of your files in the same directory.
js
// 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
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.
`js
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
$3
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'),
]
}
}
]
}
]
}
$3
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 :`js
if (loader === 'sass') {
loaders.push({
loader: 'sass-resources-loader',
options: {
resources: 'path/to/your/file.scss',
},
});
}
`$3
If you are using vue-cli@3, you need create a
file in your project root(next to package.json). Then, add the following code :`js
// 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()
})
}
}
``See Contributing to get started.