eslint-config-kentcdodds
ESLint rules for all of my personal projects. Feel free to use these conventions :-)
Table of Contents
Installation
This module is distributed via npm which is bundled with node and
should be installed as one of your project's devDependencies
:
npm install --save-dev eslint-config-kentcdodds
This library has a required peerDependencies
listing for eslint
Usage
Then add the extends to your .eslintrc.js
:
module.exports = {
extends: 'kentcdodds',
rules: {
// your overrides
},
}
Other configs
This config also exposes a few other configs that I use often and pull in as needed.
You can use them standalone:
module.exports = {
extends: 'kentcdodds/<config-name>',
}
Or in combination with the base config (recommended)
module.exports = {
extends: ['kentcdodds', 'kentcdodds/<config-name>'],
}
Note: Due to this bug you need to have the associated plugins installed to make things work. I recommend adding them as dependencies to your project if you're going to use the config for it.
babel-module
: babel-plugin-module-resolver for the import plugin to work with the module-resolver babel plugin (eslint-plugin-import and eslint-import-resolver-babel-module)babel-react-require
: babel-plugin-react-require for when you're using the react-require babel plugin (should be used with"kentcdodds/react"
as well) (eslint-plugin-react)jest
: jest testing frameworkjsx-a11y
: eslint-plugin-jsx-a11y for rules regarding accessibility with JSX (eslint-plugin-jsx-a11y)react
: React JS library (eslint-plugin-react)webpack
: Webpack for the import plugin to work with webpack overloaded imports/requires (eslint-plugin-import and eslint-import-resolver-webpack)
Things to know
- The default config uses
babel-eslint
to support stage features that ESLint doesn't support and it opts to use theeslint-plugin-babel
rules over the ESLint rules to support rules for these features as well. - All plugins needed for rules used by these configs are dependencies of this module so you don't have to install anything on your own.
- The default config actually is composed of several configurations and you can
use those individually. These are the configs it's using:
possible-errors.js
,best-practices.js
,stylistic.js
,es6/index.js
, andimport/index.js
. You can use each of these configs yourself if you want to leave my own personal style out of it. Also, thees6
andimport
configs each have apossible-errors.js
,best-practices.js
, andstylistic.js
which they are composed of as well.
Example of highly customized config
module.exports = {
extends: [
'kentcdodds/possible-errors',
'kentcdodds/best-practices',
'kentcdodds/es6/possible-errors',
'kentcdodds/import',
'kentcdodds/jest',
],
rules: {
/* custom rules */
},
}
Issues
Looking to contribute? Look for the Good First Issue label.
π Bugs
Please file an issue for bugs, missing documentation, or unexpected behavior.
π‘ Feature Requests
Please file an issue to suggest new features. Vote on feature requests by adding a π. This helps maintainers prioritize what to work on.
Contributors β¨
Thanks goes to these people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!
LICENSE
MIT