eslint-config-kentcdodds

ESLint rules according to kentcdodds' personal preference

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
eslint-config-kentcdodds
330321.0.04 months ago9 years agoMinified + gzip package size for eslint-config-kentcdodds in KB

Popular Searches

Readme

eslint-config-kentcdodds

ESLint rules for all of my personal projects. Feel free to use these conventions :-)

!Build Statusbuild-badgebuild !versionversion-badgepackage !downloadsdownloads-badgenpmtrends !MIT Licenselicense-badgelicense !All Contributorsall-contributors-badge !PRs Welcomeprs-badgeprs !Code of Conductcoc-badgecoc

Table of Contents


- Other configs - Things to know - 🐛 Bugs - 💡 Feature Requests

Installation

This module is distributed via npmnpm which is bundled with nodenode 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 eslinteslint

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>'],
}

Things to know

  • 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

module.exports = {
  extends: ['kentcdodds/import', 'kentcdodds/jest'],
  rules: {
    /* custom rules */
  },
}

Issues

Looking to contribute? Look for the Good First Issuegood-first-issue label.

🐛 Bugs

Please file an issue for bugs, missing documentation, or unexpected behavior.
See Bugsbugs

💡 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.
See Feature Requestsrequests

Contributors ✨

Thanks goes to these people (emoji keyemojis):
<td align="center"><a href="https://kentcdodds.com"><img src="https://avatars.githubusercontent.com/u/1500684?v=3?s=100" width="100px;" alt=""/><br /><sub><b>Kent C. Dodds</b></sub></a><br /><a href="https://github.com/kentcdodds/eslint-config-kentcdodds/commits?author=kentcdodds" title="Code">💻</a> <a href="https://github.com/kentcdodds/eslint-config-kentcdodds/commits?author=kentcdodds" title="Documentation">📖</a> <a href="#infra-kentcdodds" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
<td align="center"><a href="http://jonno.dev"><img src="https://avatars3.githubusercontent.com/u/1351912?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Jonathan Haines</b></sub></a><br /><a href="https://github.com/kentcdodds/eslint-config-kentcdodds/commits?author=BarryThePenguin" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/zack9433"><img src="https://avatars3.githubusercontent.com/u/1610642?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Zack Yang</b></sub></a><br /><a href="https://github.com/kentcdodds/eslint-config-kentcdodds/commits?author=zack9433" title="Code">💻</a></td>
<td align="center"><a href="https://mohamed3on.online/"><img src="https://avatars2.githubusercontent.com/u/12295159?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Mohamed Oun</b></sub></a><br /><a href="https://github.com/kentcdodds/eslint-config-kentcdodds/commits?author=Mohamed3on" title="Code">💻</a></td>
<td align="center"><a href="https://alexandernanberg.com"><img src="https://avatars3.githubusercontent.com/u/8997319?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Alexander Nanberg</b></sub></a><br /><a href="https://github.com/kentcdodds/eslint-config-kentcdodds/commits?author=alexandernanberg" title="Code">💻</a></td>
<td align="center"><a href="https://huchen.dev"><img src="https://avatars3.githubusercontent.com/u/2078389?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Hu Chen</b></sub></a><br /><a href="https://github.com/kentcdodds/eslint-config-kentcdodds/commits?author=huchenme" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/weyert"><img src="https://avatars3.githubusercontent.com/u/7049?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Weyert de Boer</b></sub></a><br /><a href="https://github.com/kentcdodds/eslint-config-kentcdodds/commits?author=weyert" title="Code">💻</a></td>
<td align="center"><a href="http://ma.vu"><img src="https://avatars3.githubusercontent.com/u/3077558?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Marko Vujanic</b></sub></a><br /><a href="https://github.com/kentcdodds/eslint-config-kentcdodds/commits?author=ultrox" title="Code">💻</a></td>
<td align="center"><a href="https://michaeldeboey.be"><img src="https://avatars3.githubusercontent.com/u/6643991?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Michaël De Boey</b></sub></a><br /><a href="https://github.com/kentcdodds/eslint-config-kentcdodds/commits?author=MichaelDeBoey" title="Code">💻</a> <a href="https://github.com/kentcdodds/eslint-config-kentcdodds/commits?author=MichaelDeBoey" title="Documentation">📖</a> <a href="#tool-MichaelDeBoey" title="Tools">🔧</a></td>
<td align="center"><a href="https://www.justindorfman.com"><img src="https://avatars1.githubusercontent.com/u/398230?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Justin Dorfman</b></sub></a><br /><a href="https://github.com/kentcdodds/eslint-config-kentcdodds/commits?author=jdorfman" title="Documentation">📖</a></td>
<td align="center"><a href="http://arvigeus.github.com"><img src="https://avatars2.githubusercontent.com/u/4872470?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Nikolay Stoynov</b></sub></a><br /><a href="https://github.com/kentcdodds/eslint-config-kentcdodds/commits?author=arvigeus" title="Documentation">📖</a></td>
<td align="center"><a href="https://www.andrewm.codes"><img src="https://avatars1.githubusercontent.com/u/18423853?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Andrew Mason</b></sub></a><br /><a href="https://github.com/kentcdodds/eslint-config-kentcdodds/commits?author=andrewmcodes" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/benmonro"><img src="https://avatars3.githubusercontent.com/u/399236?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ben Monro</b></sub></a><br /><a href="https://github.com/kentcdodds/eslint-config-kentcdodds/commits?author=benmonro" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/silviuaavram"><img src="https://avatars.githubusercontent.com/u/11275392?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Silviu Alexandru Avram</b></sub></a><br /><a href="https://github.com/kentcdodds/eslint-config-kentcdodds/commits?author=silviuaavram" title="Documentation">📖</a></td>



This project follows the all-contributorsall-contributors specification. Contributions of any kind welcome!

LICENSE

MIT