runner-generator-eslint

Tasks generator for ESLint

Installation

npm install runner-generator-eslint

Usage

Add to the scope:

const generator = require('runner-generator-eslint');

Generate tasks according to the given config:

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

Add generated tasks to the runner instance:

const runner = require('runner');

Object.assign(runner.tasks, tasks);

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 accepts two arguments: base configuration and additional options.

Base configuration

It's an object with the following properties:

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

Additional options

It's an object with the following properties:

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:

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

It will add 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.