Skip to content

Latest commit

 

History

History
227 lines (188 loc) · 5.81 KB

README.md

File metadata and controls

227 lines (188 loc) · 5.81 KB
Raw

sass-brunch

Adds Sass support to brunch.

Usage

Install the plugin via npm with npm install --save-dev sass-brunch.

Or, do manual install:

  • Add "sass-brunch": "x.y.z" to package.json of your brunch app. Pick a plugin version that corresponds to your minor (y) brunch version.
  • If you want to use git version of plugin, add "sass-brunch": "git+ssh://[email protected]:brunch/sass-brunch.git".

Options

The default compilation method is libsass, with an automatic revert to the sass ruby gem for .sass files or if compass is @imported. It is possible to set a particular mode regardless of automatic detection. If using a libsass-compatible compass replacement such as compass-mixins, it is necessary to set native mode.

Note that source maps are only supported in the native mode.

module.exports = {
  plugins: {
    sass: {
      mode: 'ruby' // set to 'native' to force libsass
    }
  }
}

Set additional include paths:

module.exports = {
  plugins: {
    sass: {
      options: {
        includePaths: ['node_modules/foundation/scss']
      }
    }
  }
}

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

module.exports = {
  plugins: {
    sass: {
      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.

module.exports = {
  plugins: {
    sass: {
      precision: 8
    }
  }
}

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

module.exports = {
  plugins: {
    sass: {
      allowCache: true
    }
  }
}

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

module.exports = {
  plugins: {
    sass: {
      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:

module.exports = {
  plugins: {
    sass: {
      options: ['--quiet']
    }
  }
}

Use sass/compass installed in custom location:

module.exports = {
  plugins: {
    sass: {
      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:

module.exports = {
  // ...
  plugins: {
    sass: {
      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)

Copyright (c) 2012-2013 Paul Miller (http://paulmillr.com)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.