ESLint rules according to kentcdodds' personal preference
npm install eslint-config-kentcdoddsESLint rules for all of my personal projects. Feel free to use these conventions :-)
---
[![Build Status][build-badge]][build]
[![version][version-badge]][package]
[![downloads][downloads-badge]][npmtrends]
[![MIT License][license-badge]][license]
[![All Contributors][all-contributors-badge]](#contributors-)
[![PRs Welcome][prs-badge]][prs]
[![Code of Conduct][coc-badge]][coc]
- Installation
- Usage
- Other configs
- Things to know
- Issues
- π Bugs
- π‘ Feature Requests
- Contributors β¨
- LICENSE
This module is distributed via [npm][npm] which is bundled with [node][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][eslint]
Then add the extends to your .eslintrc.js:
`javascript`
module.exports = {
extends: 'kentcdodds',
rules: {
// your overrides
},
}
This config also exposes a few other configs that I use often and pull in as
needed.
You can use them standalone:
`javascript`
module.exports = {
extends: 'kentcdodds/
}
Or in combination with the base config (recommended)
`javascript`
module.exports = {
extends: ['kentcdodds', 'kentcdodds/
}
- 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. You can use each of these configs yourself if you want
to leave my own personal style out of it.
#### Example of customized config
`javascript``
module.exports = {
extends: ['kentcdodds/import', 'kentcdodds/jest'],
rules: {
/ custom rules /
},
}
_Looking to contribute? Look for the [Good First Issue][good-first-issue]
label._
Please file an issue for bugs, missing documentation, or unexpected behavior.
[See Bugs][bugs]
Please file an issue to suggest new features. Vote on feature requests by adding
a π. This helps maintainers prioritize what to work on.
[See Feature Requests][requests]
Thanks goes to these people ([emoji key][emojis]):
This project follows the [all-contributors][all-contributors] specification.
Contributions of any kind welcome!
MIT
[npm]: https://www.npmjs.com
[node]: https://nodejs.org
[build-badge]: https://img.shields.io/github/workflow/status/kentcdodds/eslint-config-kentcdodds/validate?logo=github&style=flat-square
[build]: https://github.com/kentcdodds/eslint-config-kentcdodds/actions?query=workflow%3Avalidate
[version-badge]: https://img.shields.io/npm/v/eslint-config-kentcdodds.svg?style=flat-square
[package]: https://www.npmjs.com/package/eslint-config-kentcdodds
[downloads-badge]: https://img.shields.io/npm/dm/eslint-config-kentcdodds.svg?style=flat-square
[npmtrends]: http://www.npmtrends.com/eslint-config-kentcdodds
[license-badge]: https://img.shields.io/npm/l/eslint-config-kentcdodds.svg?style=flat-square
[license]: https://github.com/kentcdodds/eslint-config-kentcdodds/blob/master/LICENSE
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
[prs]: http://makeapullrequest.com
[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square
[coc]: https://github.com/kentcdodds/eslint-config-kentcdodds/blob/master/other/CODE_OF_CONDUCT.md
[emojis]: https://github.com/all-contributors/all-contributors#emoji-key
[all-contributors]: https://g.all-contributorsrcithub.com/all-contributors/all-contributors
[all-contributors-badge]: https://img.shields.io/github/all-contributors/kentcdodds/eslint-config-kentcdodds?color=orange&style=flat-square
[bugs]: https://github.com/kentcdodds/eslint-config-kentcdodds/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+sort%3Acreated-desc+label%3Abug
[requests]: https://github.com/kentcdodds/eslint-config-kentcdodds/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc+label%3Aenhancement
[good-first-issue]: https://github.com/kentcdodds/eslint-config-kentcdodds/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc+label%3Aenhancement+label%3A%22good+first+issue%22
[eslint]: https://github.com/eslint/eslint