eslint-plugin-index
v1.1.7
Published
ESlint rules to ensure the proper usage of index.js files
Downloads
34,237
Maintainers
Readme
:point_up: eslint-plugin-index
ESlint rules to ensure the proper usage of index.js files
Supported rules
| rule | description | recommended |
| ------------------------------------------------ | ------------------------------------------------------ | ----------- |
| index/only-import-export
| Allow only import and export statements in index files | error |
| index/forbid
| Forbid files named index
| off |
Installation and usage
You'll first need to install ESLint:
npm i -D eslint
Next, install eslint-plugin-index
:
npm i -D eslint-plugin-index
Add index
to the plugins section of your .eslintrc
configuration file. You can omit the eslint-plugin-
prefix:
{
"plugins": ["index"]
}
Then configure the rules you want to use under the rules section.
{
"plugins": ["index"],
"rules": {
"index/only-import-export": "error"
"index/forbid": "off"
}
}
Or start with the recommended rule set:
{
"plugins": ["index"],
"extends": ["plugin:index/recommended"]
}