Package Exports

eslint-index

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (eslint-index) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ESLint Index

CLI for finding and managing rules in ESLint config files

Installation

npm install eslint-index --save-dev

Usage

eslint-index path/to/.eslintrc [options]

Options

Option	Alias	Description	Arg Type	Arg Options
`--help`	`-h`	Display help	`Boolean`	`N/A`
`--docs`	`-d`	Display docs alongside rules	`Boolean`	`N/A`
`--format`	`-f`	Format rules	`String`	`list
`--status`	`-s`	Filter rules by status	`Array<String>`	`omitted
`--groups`	`-g`	Filter rules by group/plugin	`Array<String>`	`eslint
`--include`	`-i`	Filter rules by id	`Array<String>`	`rule-id-one rule-id-two`
`--exclude`	`-e`	Reject rules by id	`Array<String>`	`rule-id-one rule-id-two`

Examples

eslint-index .eslintrc --format table
eslint-index .eslintrc --format count
eslint-index .eslintrc --status omitted off
eslint-index .eslintrc --status warn error
eslint-index .eslintrc --groups eslint react
eslint-index .eslintrc --groups eslint --status warn error
eslint-index .eslintrc --groups eslint --status warn error --format count
eslint-index .eslintrc --include semi curly
eslint-index .eslintrc --exclude semi curly
eslint-index .eslintrc --docs
eslint-index .eslintrc --docs --groups eslint react

Author

Matthew Wagerfield @wagerfield