eslint-config-le0nik
This package provides opinionated sensible shareable Eslint configs.
NOTE: This package is in active development. Each change in minor version probably breaks API. Post 1.0 will indicate stability and will adhere to Semantic Versioning.
Usage
This package exports the following ESLint configurations for your usage.
- le0nik - default config, ES6+
- le0nik/legacy - ES5+ config
- le0nik/node - Node.js config
- le0nik/react - React.js/JSX conifg
- le0nik/lodash - lodash v4 config
- le0nik/jsdoc - JSDoc config
le0nik
Our default export contains all of our ESLint rules for ES6+.
It does not include rules for node
, react
, lodash
or jsdoc
.
You need to add those from
respectively, if you need.
It requires:
eslint
babel-eslint
eslint-plugin-babel
eslint-plugin-import
You can extend/override the rules for this config. You can find the list of rules:
Installation:
npm install --save-dev eslint-config-le0nik eslint-plugin-import eslint-plugin-babel babel-eslint eslint
- add
"extends": ["le0nik"]
to your.eslintrc.*
config.
le0nik/legacy
Lints ES5 and below.
It does not include rules for node
, react
, lodash
or jsdoc
.
You need to add those from
respectively, if you need.
It requires:
eslint
eslint-plugin-import
You can extend/override the rules for this config. You can find the list of rules:
Installation:
npm install --save-dev eslint-config-le0nik eslint-plugin-import eslint
- add
"extends": ["le0nik/legacy"]
to your.eslintrc.*
config.
le0nik/node
Lints Node.js code.
It includes Node.js
rules only.
It requires:
eslint
You can extend/override the rules for this config. You can find the list of rules here.
Installation:
npm install --save-dev eslint-config-le0nik eslint
- add
"extends": ["le0nik/node"]
to your.eslintrc.*
config.
le0nik/react
Lints React.js/JSX code.
It includes React
/JSX
rules only.
It requires:
eslint
eslint-plugin-react
You can extend/override the rules for this config. You can find the list of rules here.
Installation:
npm install --save-dev eslint-config-le0nik eslint-plugin-react eslint
- add
"extends": ["le0nik/react"]
to your.eslintrc.*
config.
le0nik/lodash
Lints lodash
v4 code.
It includes lodash
rules only.
It requires:
eslint
eslint-plugin-lodash
It only supports the default import of lodash, e.g.
var _ = require('lodash')
or import _ from 'lodash'
It does not support the usage of:
lodash/fp
- import of separate methods, like
var map = require('lodash/map')
orvar map = require('lodash').map
- usage of a name, other than
_
as yourlodash
identifier (can be changed, read below)
In your .eslintrc.*
config you can change the lodash
identifier, that this config
is going to look for, like this:
{
"extends": ["le0nik/lodash"],
"settings": {
"lodash": {
"pragma": "_" // default
}
}
}
You can extend/override the rules for this config. You can find the list of rules here.
Installation:
npm install --save-dev eslint-config-le0nik eslint-plugin-lodash eslint
- add
"extends": ["le0nik/lodash"]
to your.eslintrc.*
config.
le0nik/jsdoc
Enables requirement for valid JSDoc
comments.
It includes JSDoc
rules only.
It requires:
eslint
You can extend/override the rules for this config. You can find the list of rules here.
Installation:
npm install --save-dev eslint-config-le0nik eslint
- add
"extends": ["le0nik/jsdoc"]
to your.eslintrc.*
config.
You should combine these configurations(order does matter) to get the desired rulesets. For example:
ES6+, node and react(with jsx):
{
"extends": ["le0nik", "le0nik/node" "le0nik/react"]
}
ES6+, JSDoc and lodash:
{
"extends": ["le0nik", "le0nik/jsdoc", le0nik/lodash"]
}
ES5, node and react(with jsx):
{
"extends": ["le0nik/legacy", "le0nik/node" "le0nik/react]
}
Override config rule:
Overrides quotes: [2, "single"]
{
"extends": ["le0nik"],
"rules": {
"quotes": [2, "double"],
}
}
eslint-plugin-import
rule, if you use default
or legacy
config.
Note for It has import/no-unresolved
rule enabled and by default uses Node.js
resolver.
If you are going to use webpack with loaders specified in require/import, then you might want to install eslint-import-resolver-webpack.
If you use another module bundler, that lets you use custom
paths in require/import, then you might
want to read this.
Or you can disable this rule entirely, although I find it very useful.
{
"extends": [
"le0nik" // or "le0nik/legacy"
],
"rules": {
"import/no-unresolved": 0
}
}