Awesome
gulp-espower
A gulp plugin for power-assert.
Description
gulp-espower
is a gulp plugin to instrument "Power Assert" feature into your code.
Internally, gulp-espower
task uses espower
module that manipulates assertion expression (JavaScript Code) defined in The ESTree Spec (formerly known as Mozilla SpiderMonkey Parser API), to instrument power-assert feature into the code. The magic is done by using Esprima and Escodegen.
Pull-requests, issue reports and patches are always welcomed. See power-assert project for more documentation.
Usage
First, install gulp-espower
as a development dependency:
npm install --save-dev gulp-espower
Then, add it to your gulpfile.js
:
var espower = require('gulp-espower');
gulp.src('./test/*.js')
.pipe(espower())
.pipe(gulp.dest('./dist'));
Source maps
gulp-espower works with gulp-sourcemaps to generate source maps for the instrumented javascript code. Note that you should init
gulp-sourcemaps prior to running the gulp-espower and write
the source maps after. gulp-espower works well with some gulp plugins that supports gulp-sourcemaps.
var espower = require('gulp-espower');
var coffee = require('gulp-coffee');
var concat = require('gulp-concat');
var sourcemaps = require('gulp-sourcemaps');
// compile, instrument then concatinate
gulp.src('./test/*test.coffee')
.pipe(sourcemaps.init())
.pipe(coffee())
.pipe(espower())
.pipe(concat('all_test.js'))
.pipe(sourcemaps.write())
.pipe(gulp.dest('./build'));
// will write the source maps inline in the code
For more information, see gulp-sourcemaps.
API
espower(options)
options.patterns
type | default value |
---|---|
Array of string | objects shown below |
[
'assert(value, [message])',
'assert.ok(value, [message])',
'assert.equal(actual, expected, [message])',
'assert.notEqual(actual, expected, [message])',
'assert.strictEqual(actual, expected, [message])',
'assert.notStrictEqual(actual, expected, [message])',
'assert.deepEqual(actual, expected, [message])',
'assert.notDeepEqual(actual, expected, [message])',
'assert.deepStrictEqual(actual, expected, [message])',
'assert.notDeepStrictEqual(actual, expected, [message])'
]
Target patterns for power assert feature instrumentation.
If callee name (for example, assert.equal
) matches exactly and number of arguments is satisfied, then the assertion will be modified.
Detection is done by escallmatch. Any arguments enclosed in bracket (for example, [message]
) means optional parameters. Without bracket means mandatory parameters.
CHANGELOG
See CHANGELOG
OUR SUPPORT POLICY
We support Node under maintenance. In other words, we stop supporting old Node version when their maintenance ends.
This means that any other environment is not supported.
NOTE: If gulp-espower works in any of the unsupported environments, it is purely coincidental and has no bearing on future compatibility. Use at your own risk.
AUTHOR
CONTRIBUTORS
License
Licensed under the MIT license.