ruby-sass-loader/README.md

Compile sass/scss files with webpack using the original ruby sass implementation

# sass loader for [webpack](http://webpack.github.io/)

[![Build Status][travis-image]][travis-url] [![Coverage Status][coveralls-image]][coveralls-url]

## Setup

Use `style!css!ruby-sass` as the loader in your `webpack.config`. If you want to generate source maps use `css?sourceMap` instead of `css`. Supply any of the options as query string to ruby-sass like `ruby-sass?requires[]=sass-globbing&outputStyle=nested`

### Options

#### sourceMap
Generate source maps.

#### compass
Enabled the --compass argument.

#### outputStyle
Controls the --style argument. See [Output Style](http://sass-lang.com/documentation/file.SASS_REFERENCE.html#output_style) for allowed values.

#### includePaths[]
Controls the --load-path argument. See [@-Rules and Directives](http://sass-lang.com/documentation/file.SASS_REFERENCE.html#directives).

#### requires[]
Controls the --require argument.

#### buildPath
Specify a custom build path. If not given the sass and cache files will be compiled in a temporary directory (os.tmpdir() + '/ruby-sass-loader')

#### outputFile
Specify a custom output filename. If not specified the sass and cache files will be compiled into 'out.css' and 'out.css.map'

#### cwd
Specify a working directory. Defaults to the directory of the sass file.


### Simple example

``` javascript
module.exports = {
  module: {
    loaders: [
      {
        test: /\.scss$/,
        loader: 'style!css?sourceMap!ruby-sass?sourceMap'
      }
    ]
  }
};
```

### Advanced example

``` javascript
module.exports = {

  entry: [
       /* smth */
       './styles/main.scss'
  ],

  module: {
    loaders: [
      /* some other loaders */
      {
        test: /\.scss$/,
        loader: 'style!css!ruby-sass?outputStyle=expanded' +
                '&includePaths[]=' +
                    path.resolve(__dirname, './node_modules/zurb-foundation/scss') +
                '&includePaths[]=' +
                    path.resolve(__dirname, './styles/') +
                '&buildPath=' +
                    path.resolve(__dirname, './build/') +
                '&outputFile=bundle.css'
      }
    ]
  }
};
```

## Install

`npm install ruby-sass-loader`

## License

[MIT](http://www.opensource.org/licenses/mit-license.php)


[travis-image]: https://travis-ci.org/ddelbondio/ruby-sass-loader.svg?branch=master
[travis-url]: https://travis-ci.org/ddelbondio/ruby-sass-loader

[coveralls-image]: https://coveralls.io/repos/ddelbondio/ruby-sass-loader/badge.svg?branch=master&service=github
[coveralls-url]: https://coveralls.io/github/ddelbondio/ruby-sass-loader?branch=master