grunt-warn-match

Warn if files contain a match for a specified string

grunt-warn-match

Warn if files contain a match for a specified string

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-warn-match --save-dev

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

grunt.loadNpmTasks 'grunt-warn-match'

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

grunt.initConfig
  match:
    files:
      src: ['app/**/*.coffee']
    options:
      str: 'debugger'
      fail: false

Type: String Default value: ', '

A string value that is used to do something with whatever.

Type: String Default value: '.'

A string value that is used to do something else with whatever else.

In this example, the default options are used to warn if the match is found

grunt.initConfig
  match:
    files:
      src: ['app/**/*.coffee']
    options:
      str: 'debugger'
      fail: false

In this example, custom options are used to fail if the match is found

grunt.initConfig
  match:
    files:
      src: ['app/**/*.coffee']
    options:
      str: 'debugger'
      fail: true

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.

0.1.0 Initial version