jasonbekolay / broccoli-eslint

Lint JavaScript using Eslint

broccoli-eslint

Lint JavaScript using Eslint

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

Install

npm install --save broccoli-eslint

Example

Note: The API will change in subsequent 0.x versions.

var eslint = require('broccoli-eslint');
tree = eslint(tree, options);

API

eslint(tree, options)

options

config

Type: String Default: ./eslint.json

Path to eslint configuration file.

rulesdir

Type: String Default: built-in rules directory

Path to a directory with custom rules. Your custom rules will be used in addition to the built-in ones.

Recommended read: Working with Rules

format

Type: String Default: 'eslint/lib/formatters/stylish'

Path path to a custom formatter (See eslint/tree/master/lib/formatters for alternatives).