broccoli-lint-eslint

broccoli-lint-eslint

Lint JavaScript with ESLint as part of your Broccoli build pipeline.

Most of the test setup and the build configuration is based on sindresorhus/grunt-eslint. The internal validation is heavily inspired by eslint cli.js.

Installation

npm install broccoli-lint-eslint@2

Usage

var eslint = require('broccoli-lint-eslint');
var outputNode = eslint(inputNode, options);

API

• inputNode A Broccoli node

• options {Object}: Options to control how broccoli-lint-eslint is run.

  • format {string|function}: The path, or function reference, to a custom formatter (See eslint/tree/master/lib/formatters for alternatives).

    Default: 'eslint/lib/formatters/stylish'

  • testGenerator {string|function(relativePath, errors), returns reporter output string}: The function used to generate test modules. You can provide a custom function for your client side testing framework of choice.

    Default: null

    If you provide a string one of the predefined test generators is used. Currently supported are qunit and mocha.

    Example usage:

    var path = require('path');
    
    function testGenerator(relativePath, errors) {
      return "module('" + path.dirname(relativePath) + "');\n";
             "test('" + relativePath + "' should pass ESLint', function() {\n" +
             "  ok(" + passed + ", '" + moduleName + " should pass ESLint." + (errors ? "\\n" + errors : '') + "');\n" +
             "});\n";
    };
    
    return eslint(inputNode, {
      options: {
        configFile: this.jshintrc.app + '/eslint.json',
        rulesdir: this.jshintrc.app
      },
      testGenerator: testGenerator
    });
    

  • throwOnError {boolean}: Cause exception error on first violation with error-level severity.

    Default: false

  • throwOnWarn {boolean}: Cause exception error on first violation with warn-level severity. NOTE: Setting this to true will automatically enable throwOnError behavior.

    Default: false

  • options {options}: Options native to ESLint CLI. While all options will be passed to the ESLint CLIEngine, these are the ones that broccoli-lint-eslint makes use of in particular:

    • configFile {string}: Path to eslint configuration file.

      Default: ./eslintrc

    • rulePaths {Array}: Paths to a directory with custom rules. Your custom rules will be used in addition to the built-in ones. Recommended read: Working with Rules.

      Default: built-in rules directory

    • ignore {boolean}: false disables use of .eslintignore, ignorePath and ignorePattern

      Default: true

Changelog

v2.7.0 (2016-09-13)

Full Changelog

Implemented enhancements:

• Add support for setting throwOnWarn option #45

Closed issues:

• Minimum builderFeatures required; persistent output flag error #39

Merged pull requests:

• add support for throwOnWarn option #60 (BrianSipple)
• Clean up testing syntax and overall architecture #59 (BrianSipple)
• [2.x] Fix throwOnError support and add test #58 (BrianSipple)
• Merge 2.6.0 release back into master branch #57 (Turbo87)