ember-clibroccoli-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 --save broccoli-lint-eslint
broccoli-lint-eslint@5 uses eslint@5 which requires Node.js 6 or above.
If you need support for Node.js 4, you may use broccoli-lint-eslint@4 which
uses eslint@4 and is compatible with Node.js 4:
npm install --save broccoli-lint-eslint@4
Usage
var ESLint = require('broccoli-lint-eslint');
var outputNode = ESLint.create(inputNode, options);
API
inputNodeA Broccoli nodeoptions{Object}: Options to control howbroccoli-lint-eslintis 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{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- relativePath - The relative path to the file being tested.
- errors - An array of eslint error objects found.
If you provide a
stringone of the predefined test generators is used. Currently supported arequnitandmocha.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.create(inputNode, { options: { configFile: this.eslintrc.app + '/eslint.json' }, testGenerator: testGenerator });group{string|undefined}: Groups the generated ESLint tests into a single file and test suite with the given group name.Default:
undefinedthrowOnError{boolean}: Cause exception error on first violation witherror-level severity.Default:
falsethrowOnWarn{boolean}: Cause exception error on first violation withwarn-level severity. NOTE: Setting this to true will automatically enablethrowOnErrorbehavior.Default:
falsepersist{boolean}: Persist the state of filter output across restartsDefault:
falseconsole: {Object}: A custom console object with alogmethod forbroccoli-lint-eslintto use when logging formatter output.Default: The global
consoleobjectoptions{options}: Options native to ESLint CLI. While all options will be passed to the ESLint CLIEngine, these are the ones thatbroccoli-lint-eslintmakes use of in particular:configFile{string}: Path to eslint configuration file.Default:
./eslintrcrulePaths{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}:falsedisables use of.eslintignore,ignorePathandignorePatternDefault:
true
extensions{Array}: File extensions to lint. NOTE: If you add Typescript filestypescript-eslint-parserhas to be installed and specified as the parser. For more information take a look at thetypescript-eslint-parserDefault:
['js']