Skip to content
Adds Stylus support to Brunch
JavaScript CSS
Latest commit cda5740 Apr 2, 2016 @paulmillr paulmillr Release 2.6.0.
Failed to load latest commit information.
fixtures Un-coffee Dec 26, 2013
.eslintrc.json Update ESLint to 2.1.0 Feb 16, 2016
.gitignore Remove lib from gitignore. Apr 7, 2013
.npmignore Stuff Feb 26, 2014
.travis.yml Add travis. Feb 9, 2016
CHANGELOG.md Add support for CSS modules Mar 18, 2016
README.md Release 2.6.0. Apr 2, 2016
index.js Release 2.6.0. Apr 2, 2016
package.json Release 2.6.0. Apr 2, 2016
test.js Add support for CSS modules Mar 18, 2016

README.md

stylus-brunch

Adds Stylus support to brunch.

Also includes nib cross-browser mixins.

Usage

Install the plugin via npm with npm install --save stylus-brunch.

Or, do manual install:

  • Add "stylus-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 "stylus-brunch": "git+ssh://git@github.com:brunch/stylus-brunch.git".

Options

Use Plugin Middleware

You can include Stylus plugins with a config directive config.plugins.stylus.plugins (array) with paths to require the needed plugins. You will have to include your plugin dependencies in package.json.

config =
  plugins:
    stylus:
      plugins: ['my-stylus-plugin']

Options

You can import your modules or Stylus sheets with a config directive config.plugins.stylus.imports (array) with paths to your modules.

config =
  plugins:
    stylus:
      imports: ['']

Allow stylus files to include plain-css partials:

config =
  plugins:
    stylus:
      includeCss: true

Debugging

Enable line number comments or FireStylus for Firebug debug messages (both are off by default)

config =
  plugins:
    stylus:
      linenos: true
      firebug: true

CSS Modules

Starting Brunch <unreleased>, you can use CSS Modules with stylus-brunch. To enable it, change your config to:

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

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.styl');

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

Note: enabling cssModules does so for every stylesheet in your project, so it's all-or-nothing. 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).

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.

Something went wrong with that request. Please try again.