@runner/generator-eslint

Tasks generator for ESLint

Installation

npm install @runner/generator-eslint

Usage

Add to the scope:

var generator = require('@runner/generator-eslint');

Add generated tasks to the runner instance:

var runner = require('@runner/core');

runner.tasks(
    generator({
        watch: ['src/js/**/*.js']
    })
);

The following tasks will become available:

Task name	Description
eslint:config	prints the current configuration used for generated tasks
eslint:watch	starts file changes monitoring, prints warnings on errors
eslint:unwatch	stops monitoring

Generator configuration object:

Name	Description
watch	file, dir, glob, or array passed to watch in chokidar
watchOptions	optional watcher config object parameters
options	optional config object passed to ESLint CLIEngine

Additional generator options:

Name	Description
prefix	an affix placed before a task name (default is eslint:)
suffix	a string added at the end of a task name (empty by default)

So it's possible to change generated tasks names:

runner.tasks(
    generator(config, {
        prefix: 'lint:',
        suffix: ':develop'
    })
);

This will create the following tasks:

• lint:config:develop
• lint:watch:develop
• lint:unwatch:develop

Contribution

If you have any problems or suggestions please open an issue according to the contribution rules.

License

@runner/generator-eslint is released under the GPL-3.0 License.