eslint-plugin-voog
v0.3.2
Published
A collection of ESLint rules for import declaration ordering and more
Downloads
97
Maintainers
Readme
eslint-plugin-voog
A collection of ESLint rules used at Voog.
Installation
You'll first need to install ESLint:
npm i eslint --save-dev
Next, install eslint-plugin-voog
:
npm install eslint-plugin-voog --save-dev
Usage
Add voog
to the plugins section of your .eslintrc
configuration file. You
can omit the eslint-plugin-
prefix:
{
"plugins": [
"voog"
]
}
Then configure the rules you want to use under the rules section.
{
"rules": {
"voog/enforce-import-ordering": [
"error",
{
"blockOrder": [
"foreign",
"local",
"constant"
],
"blockMembershipTests": {
"constant": {
"namedTest": "constant"
},
"local": "^\\.\\.?/",
"foreign": "^\\w+$"
},
"ignore": "/utils/",
"checkImportsOnTop": true,
"checkBlockSeparation": false
}
],
"voog/let-const-on-top": ["error"],
"voog/reexporting-index-modules": ["error"]
}
}
The preceding configuration would accept the following module:
import React from 'react';
import cc from 'classcat';
import MyComponent from './MyComponent';
import FurtherComponent from '../elsewhere/FurtherComponent';
import {A_CONSTANT} from 'constants';
import {doStuff} from 'shared/utils/computations'; // this declaration ignored
but would not accept the following:
import MyComponent from './MyComponent';
import {A_CONSTANT} from 'constants';
import FurtherComponent from '../elsewhere/FurtherComponent';
import React from 'react';
import cc from 'classcat';
You may choose to simply utilize the configuration we use internally at Voog:
{
"extends": ["plugin:voog/voog"]
}
Supported rules
enforce-import-ordering
A rule to enforce the following conditions:
- Import declarations must appear sorted into blocks defined by
blockOrder
andblockMembershipTests
. - Import declaration blocks must be separated by at least two newlines (unless
checkBlockSeparation
is explicitly set to false). - Import declarations must appear before any other statements in a source file
(unless
checkImportsOnTop
is explicitly set to false).
Configuration
blockOrder
Array (required)An array of strings specifying an ordering of import declaration blocks. The strings are freely chosen to describe the import block, e.g.
"foreign"
,"local"
or"constant"
.blockMembershipTests
Object (required)An object whose keys are
blockOrder
members and whose values are regular expressions matched against the import source (the string signifying what to import, i.e. the final component of an import declaration), or named tests. Named tests are invoked by a structure{"namedTest": <classifier>}
where<classifier>
is a string referring to a built-in import declaration classifier. Currently the only supported classifier isconstant
which matches if all of the imported symbols consist solely of uppercase characters or underscores and begin with an uppercase character. Note that:- Every
blockOrder
member is required to have a corresponding entry inblockMembershipTests
. - The order of
blockMembershipTests
is significant, as the tests are matched in order and the import declaration is classified by the first match.
- Every
ignore
ArrayAn array of regular expressions matched against the import source. Matching declarations are not classified and ignored.
checkBlockSeparation
BooleanIf true, enforce the requirement that import declaration blocks must be separated by at least two newlines.
checkImportsOnTop
BooleanIf true, enforce the requirement that every import declaration must appear before any other statement in the file. Defaults to true.
let-const-on-top
Require let and const declarations at the top of their containing scope. This rule is currently not configurable.
reexporting-index-modules
Detect React index modules matching the regular expression
[A-Z]\w+/index\.js$
and only allow these to only contain import declarations
importing from its containing directory and export declarations re-exporting
previously imported symbols.
Debugging
eslint-plugin-voog
uses the debug
package for debugging. To turn on debugging for a specific rule, set the DEBUG
environment variable to eslint-plugin-voog:<rule>
. To turn on debugging
globally for the plugin, set DEBUG
to eslint-plugin-voog:*
:
$ DEBUG=eslint-plugin-voog:enforce-import-ordering
$ npx eslint
$ DEBUG='eslint-plugin-voog:*'
$ npx eslint