grunt-espower

A grunt task for power-assert

grunt-espower

A grunt task for power-assert.

grunt-espower is a grunt task to instrument "Power Assert" feature into your code.

Internally, grunt-espower task uses espower module that manipulates assertion expression (JavaScript Code) represented as Mozilla JavaScript AST, to instrument power-assert feature into the code. The magic is done by using Esprima and Escodegen.

Since 0.9.0, grunt-espower supports sourcemaps by default.

Pull-requests, issue reports and patches are always welcomed. See power-assert project for more documentation.

This plugin requires Grunt ~0.4.1

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-espower --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-espower');

In your project's Gruntfile, add a section named espower to the data object passed into grunt.initConfig().

grunt.initConfig({
  espower: {
    options: {
      // Task-specific options go here. 
    },
    your_target: {
      // Target-specific file lists and/or options go here. 
    },
  },
})
typedefault value
Array of stringobjects 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.

grunt.initConfig({
  espower: {
    test: {
      files: [
        {
          expand: true,        // Enable dynamic expansion. 
          cwd: 'test/',        // Src matches are relative to this path. 
          src: ['**/*.js'],    // Actual pattern(s) to match. 
          dest: 'espowered/',  // Destination path prefix. 
          ext: '.js'           // Dest filepaths will have this extension. 
        }
      ]
    },
  },
})
grunt.initConfig({
  espower: {
    demo: {
      options :{
        patterns: [
            '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])'
        ]
      },
      files: [
        {
          expand: true,        // Enable dynamic expansion. 
          cwd: 'demo/',        // Src matches are relative to this path. 
          src: ['**/*.js'],    // Actual pattern(s) to match. 
          dest: 'espowered_demo/',  // Destination path prefix. 
          ext: '.js'           // Dest filepaths will have this extension. 
        }
      ]
    },
  },
})

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

See CHANGELOG

Licensed under the MIT license.