Gulp-task-stylus NPM

gulp-task-stylus

Gulp task for processing Stylus files with the option to watch the emitted source files for changes.

Usage

import gulp from 'gulp';
import stylus from 'gulp-task-stylus';

gulp.task('styles', stylus({
  base: 'app',
  src: 'stylesheets/*',
  dest: 'public',
  sourcemaps: true
}));

$ gulp styles

Example

Run $ npm run example to see it in action.

API

`stylus(options[, extendsDefaults])`

`options`

Type: Object Default:

{
  base: undefined,
  dest: undefined,
  src: undefined,
  watch: undefined,
  stylus: {
    'include css': true
  },
  autoprefixer: undefined,
  nano: false,
  purify: false,
  sourcemaps: true,
  envs: {
    production: {
      nano: {},
      sourcemaps: false
    }
  }
}

Options that define the behavior of this task. This object is parsed by config() in gulp-task-helpers, so you can target specific NODE_ENV environments.

`options.base`

Type: string Default: undefined

If specified, this is the base path for the source files to emit into the stream. Patterns defined in options.src will be prefixed by this path.

`options.src`

Type: string or string[] Default: undefined

Glob pattern(s), relative to options.base if specified, that specifies what files to emit into the Gulp stream. These patterns are automatically appended with a wildcard glob of affected file extensions unless custom extensions are specified in the patterns.

`options.dest`

Type: string Default: undefined

Path of destination directory to write files to.

`options.watch`

Type: Object or boolean

Options that define the file watching behavior. If set to false, watching will be disabled regardless of the --watch flag.

`options.watch.files`

Type: string or string[] Default: Emitted source files

Glob pattern(s) that matches the files to be watched. Defaults to the emitted source file patterns computed from options.base and options.src.

`options.watch.tasks`

Type: string, Function or Array Default: Current task name

Task(s) or methods to invoke whenever watched files have changed. This array is applied to run-sequence. Defaults to the current task name.

`options.stylus`

Type: Object Default:

{
  'include css': true,
  include: [
    {Directory of source files},
    {Directory of Node modules}
  ]
}

Options for gulp-stylus.

`options.autoprefixer`

Type: Object Default: undefined

Options for autoprefixer.

`options.nano`

Type: Object Default: false, {} in production

Options for cssnano.

`options.purify`

Type: Object Default: false

Options for gulp-purifycss.

`options.sourcemaps`

Type: boolean Default: true, false when NODE_ENV=production

Specifies whether sourcemaps are enabled.

`extendsDefaults`

Type: boolean Default: true

Maps to useConcat param in config() of gulp-task-helpers.

Watching for Changes

You can pass a --watch or --w flag to the Gulp command to enable file watching, like so:

$ gulp styles --watch

By default, files that were emitted as source files will be marked for watching and the task name assigned to this module will be executed whenever a file changes. To override this behavior see options.watch.