@linagora/grunt-lint-pattern

Search for patterns in files. Error if any match.

Stats

StarsIssuesVersionUpdatedCreatedSize
@linagora/grunt-lint-pattern
010.1.44 years ago4 years agoMinified + gzip package size for @linagora/grunt-lint-pattern in KB

Readme

grunt-lint-pattern

This is a fork of grunt-lint-pattern

Find a pattern in files. Error if any match.

Getting Started

This plugin requires Grunt >=0.4.0

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 @linagora/grunt-lint-pattern --save-dev

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

grunt.loadNpmTasks('@linagora/grunt-lint-pattern');

The "lint_pattern" task

Overview

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

grunt.initConfig({
  lint_pattern: {
    your_target: {
      options: {
        rules: [
          {
            pattern: /console\./;
            message: 'Calling "console." is not allowed.'
          },
        ],
      },
      files: {
        '**.js',
      },
    },
    your_target: {
      options: {
        rules: [
          {
            pattern: /moz-border-radius/;
            message: 'Do not use vendor prefixes for the border-radius property.'
          },
          {
            pattern: /!important/;
            message: 'Do not use "!important".'
          },
        ],
      },
      files: {
        '**.css',
      },
    },
  },
})

Options

options.rules

Type: Array Required

An array of "rules" that will be used to test files. Rules have the form:

pattern

Type: RegExp Required

.test will be called on this regular expression with the entire contents of a single file as the argument (This is not called once per line of a file). If the result of .test is true, then the rule is failed and an error is raised.

message

Type: string Optional

A message that will print when pattern is found.

Usage Examples

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

  • 0.1 Initial release

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.