1.0.0 • Published 6 years ago
@runner/generator-sass v1.0.0
Tasks generator for SASS
Installation
npm install @runner/generator-sass
Usage
Add to the scope:
var generator = require('@runner/generator-sass');
Generate tasks according to the given config:
var tasks = generator({
file: 'src/sass/develop.scss',
outFile: 'build/develop/main.css',
sourceMap: 'build/develop/main.css.map'
});
Add generated tasks to the runner
instance:
var runner = require('@runner/core');
Object.assign(runner.tasks, tasks);
The following tasks will become available:
Task name | Description |
---|---|
sass:config | prints the current configuration used for generated tasks |
sass:build | performs sass compilation |
sass:clear | removes compiled files |
Generator accepts two arguments: base configuration and additional options.
Base configuration
It's a node-sass config passed to the render.
Additional options
It's an object with the following properties:
Name | Description |
---|---|
prefix | an affix placed before a task name (default is sass: ) |
suffix | a string added at the end of a task name (empty by default) |
So it's possible to change generated tasks names:
Object.assign(runner.tasks,
generator(config, {
prefix: 'css:',
suffix: ':develop'
})
);
It will add the following tasks:
css:config:develop
css:build:develop
css:clear:develop
Contribution
If you have any problems or suggestions please open an issue according to the contribution rules.
License
@runner/generator-sass
is released under the GPL-3.0 License.
1.0.0
6 years ago