grunt-minerr-strip

Strips minErr error messages from your build.

npm install grunt-minerr-strip
5 downloads in the last month

grunt-minerr-strip

Strips minErr error messages from your build.

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-minerr-strip --save-dev

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

grunt.loadNpmTasks('grunt-minerr-strip');

The "minerr_strip" task

Overview

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

grunt.initConfig({
  minerr_strip: {
    'errors.json': {
      files: {
        'foo.strip.js': 'foo.js',
        'bar.strip.js': 'bar.js',
        'baz.strip.js': 'baz.js'
      },
      url: 'http://example.com/minerr/'
    }
  },
})

This example strips minErr errors from the files foo.js, bar.js and baz.js, producing foo.strip.js, bar.strip.js and baz.strip.js respectively. URLs logged to the command line will start with http://example.com/minerr/.

Usage Examples

Options

Each target produces a JSON file of the same name containing errors and metadata. It can be configured with the following options:

files

Type: object Default value: {}

Each entry is a string mapping to string. The object maps stripped file names to the dependent file to strip.

url

Type: string Default value: ''

This url will be substituted in the production minErr implementation which is in turn substituted for minErr definitions in user code.

Contributing

Pull requests are welcome! Remember to keep the following rules in mind:

  • All features or bug fixes must be documented by one or more specs. We use Jasmine.
  • Submissions must pass JSHint. Run grunt jshint to check this.
  • Instead of complex inheritance hierarchies, we prefer simple objects. We use prototypical inheritance only when absolutely necessary.
  • We love functions and closures and, whenever possible, prefer them over objects.

Release History

  • 2013-06-26 v0.1.0 Initial release
npm loves you