optimizer-stylus

This plugin for the RaptorJS Optimizer provides support for rendering Stylus dependencies to CSS.

Installation

First install the plugin:

npm install optimizer-stylus --save

Then, enable the plugin when configuring the RaptorJS Optimizer:

require('optimizer').configure({
        plugins: [
            {
                module: 'optimizer-stylus',
                config: {
                    ... // See Configuration below
                }
            }
        ]
    });

Usage

Once this plugin has been enabled, you can then add Stylus dependencies to your optimizer.json files. The file extension for Stylus files is expected to be .styl. Example:

optimizer.json:

{
    "dependencies": [
        "style.styl"
    ]
}

Configuration

The configuration for the optimizer-stylus plugin supports the following properties:

• defines: An array of functions to make available to Stylus files (see Stylus API » define)
• imports: An array of paths to Stylus files that should be globally imported to every Stylus file (see Stylus API » import)
• includes: An array of directory paths to add to the search path (see Stylus API » include)
• set: An object containing key/value settings for the Stylus renderer (see Stylus API » set)
• use: An array of library functions for Stylus (see Stylus API » use)

Example configuration:

require('optimizer').configure({
        plugins: [
            {
                module: 'optimizer-stylus',
                config: {
                    includes: [nodePath.join(__dirname, 'stylus/mixins/')],
                    use: function(stylus) {
                        stylus.define('add', function(a, b) {
                            a = parseFloat(a);
                            b = parseFloat(b);
                            return a+b;
                        });
                    },
                    define: {
                        sub: function(a, b) {
                            a = parseFloat(a);
                            b = parseFloat(b);
                            return a-b;
                        }
                    },
                    imports: [
                        nodePath.join(__dirname, 'stylus/variables.styl')
                    ]
                }
            }
        ]
    });