grunt-espower

A grunt task for power-assert

npm install grunt-espower
3 downloads in the last day
86 downloads in the last week
246 downloads in the last month

grunt-espower

Build Status NPM version Dependency Status Built with Grunt

A grunt task for power-assert.

DESCRIPTION

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.

Please note that grunt-espower is a beta version product. Pull-requests, issue reports and patches are always welcomed. See power-assert project for more documentation.

Getting Started

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');

The "espower" task

Overview

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.
    },
  },
})

Options

options.powerAssertVariableName

Type: String Default value: 'assert'

Target variable name to instrument.

options.lineSeparator

Type: String Default value: '\n'

Line separator in target sources.

options.targetMethods

Type: Object Default value:

targetMethods: {
    oneArg: [
        'ok'
    ],
    twoArgs: [
        'equal',
        'notEqual',
        'strictEqual',
        'notStrictEqual',
        'deepEqual',
        'notDeepEqual'
    ]
}

Target assertion methods to insrtument.

  • oneArg array for assertion methods with a expression argument (like assert.ok(actual))
  • twoArgs array for assertion methods with two expression arguments (like assert.equal(actual, expected))

Usage Examples

Default Options

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.
        }
      ]
    },
  },
})

Custom Options

grunt.initConfig({
  espower: {
    demo: {
      options :{
        destructive: true,
        powerAssertVariableName: 'test',
        lineSeparator: '\r\n'
        targetMethods: {
            oneArg: [
                'ok',
                'ng'
            ],
            twoArgs: [
                'equal',
                'notEqual',
                'strictEqual',
                'notStrictEqual',
                'deepEqual',
                'notDeepEqual',
                'projectSpecificEqual',
                'notProjectSpecificEqual'
            ]
        }
      },
      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.
        }
      ]
    },
  },
})

Contributing

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.

RELEASE HISTORY

See Release History

AUTHOR

LICENSE

Licensed under the MIT license.

npm loves you