Skip to content

runner/core

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Task runner core

build status npm version dependencies status devDependencies status Gitter RunKit

Installation

npm install @runner/core

Usage

Add to the scope:

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

Create a simple task:

runner.task('make', function () {
    // some actions
});

More examples of tasks creation and execution are available in the @cjssdk/runner package.

Add an alias to an existing task:

runner.alias('build', 'make');

Run task on a key or keys combination press:

runner.keystroke('build', 'ctrl+b');

Files watching

To execute a specific task on some file changes:

runner.watch('src/script/**/*.js', 'webpack:build');

To execute a named or anonymous function:

runner.watch('src/script/**/*.js', function rebuild ( done ) {
    // function name "rebuild" is used as task name
    // otherwise <noname> is printed
    done();
});

To execute task series:

runner.watch('src/script/**/*.js', runner.serial('lint', 'build'));

Before calling runner.watch it's possible to configure the watch:

runner.watch.config = {
    // some configuration 
};

All available configurations you can see in the underlying chokidar package.

Contribution

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

License

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