max3a3/sass-brunch

Adds Sass / Scss support to brunch

sass-brunch

Adds Sass support to Brunch.

Usage

Install the plugin via npm with npm install -S sass-brunch.

Options

Set additional include paths:

includePaths: ['node_modules/foundation/scss']

Print line number references as comments or sass's FireSass fake media query:

debug: 'comments' // or set to 'debug' for the FireSass-style output

Set the precision for arithmetic operations. This is useful for building Bootstrap, Zurb Foundation, and the like.

precision: 8

Allow the ruby compiler to write its normal cache files in .sass-cache (disabled by default). This can vastly improve compilation time.

allowCache: true

To enable embedded source maps, pass the option sourceMapEmbed. This is only supported in native mode; Ruby Sass isn't supported.

sourceMapEmbed: true

To include the source files' name/path in either debug mode, create a parent file that @include your actual sass/scss source. Make sure the source files are renamed to start with an underscore (_file.scss), or otherwise exclude them from the build so they don't get double-included.

To pass any other options to sass:

options: ['--quiet']

Use sass/compass installed in custom location:

gem_home: './gems'

This could be useful for the environment which doesn't allow to install gems globally, such as CI server.

Use libsass experimental custom functions:

var types = require('node-sass').types
module.exports = {
  plugins: {
    sass: {
      mode: 'native', // custom functions are only supported in 'native' mode
      functions: {
        sin: function(val) { types.Number(Math.sin(val.getValue())) },
        cos: function(val) { types.Number(Math.cos(val.getValue())) },
        tan: function(val) { types.Number(Math.tan(val.getValue())) }
      }
    }
  }
}

CSS Modules

Starting Brunch 2.6.0, you can use CSS Modules with css-brunch. To enable it, change your config to:

module.exports = {
  // ...
  plugins: {
    sass: {
      modules: true
    }
  }
};

You can also pass options directly to postcss-modules:

generateScopedName: '[name]__[local]___[hash:base64:5]'

Then, author your styles like you normally would:

.title {
  font-size: 32px;
}

And reference CSS class names by requiring the specific style into your javascript:

var style = require('./title.scss');

<h1 className={style.title}>Yo</h1>

Note: enabling cssModules does so for every stylesheet in your project, even the files you don't require will be transformed into CSS modules (aka will have obfuscated class names, like turn .title into ._title_fdphn_1).

You must use the ignore option to specifically opt out of files or directories where you don't want to use cssModules.

The ignore option takes an array of matches. Anymatch is used to handle the matching. See the anymatch documentation for more information.

module.exports = {
  // ...
  plugins: {
    sass: {
      modules: {
        ignore: [/file\.css/, /some\/path\/to\/ignore/]
      }
    }
  }
};

License

The MIT License (MIT)