Skip to content

DarkPark/node-runner

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Task runner

build status npm version dependencies status devDependencies status Gitter

Installation

Can be local or global.

npm install node-runner --global

Usage

Add to the scope:

var runner = require('node-runner');

Tasks configuration

@todo

Logging

General output in different colors:

// 16:25:30.811 simple line
runner.log.info('simple line');

// 16:25:30.811 warning message
runner.log.warn('warning message');

// 16:25:30.811 error
runner.log.fail('error');

// print some complex data
runner.log.inspect(someObject);

Access colors instance:

var colors = runner.log.colors;

runner.log.info(
    colors.black.bgYellow('black text on yellow background')
);

Some task specific output:

var log = runner.log.wrap('webpack');

// 16:25:30.811 [webpack] build is ok
log.info('build is ok');

Helpers

var tools = require('node-runner/lib/tools');

Remove some generated files:

tools.unlink(
    ['build/develop/main.css', 'build/develop/main.js'],
    log,
    function ( error ) {
        console.log(error);    
    }
);

Write generated files content:

tools.write(
    [{name: 'build/develop/main.js', data: someContent}],
    log,
    function ( error ) {
        console.log(error);    
    }
);

Create new directories and any necessary subdirectories:

tools.mkdir(
    ['build/develop', 'build/release'],
    log,
    function ( error ) {
        console.log(error);    
    }
);

Modules

Activate system popup notifications on errors:

require('node-runner/lib/notify');

Add system task status to get all tasks running state:

require('node-runner/lib/status');

Contribution

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

License

node-runner is released under the GPL-3.0 License.