Skip to content

kentcdodds/eslint-config-kentcdodds

Repository files navigation

eslint-config-kentcdodds

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


Build Status version downloads MIT License All Contributors PRs Welcome Code of Conduct

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

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 Issue label.

๐Ÿ› Bugs

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

See Bugs

๐Ÿ’ก 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 Requests

Contributors โœจ

Thanks goes to these people (emoji key):


Kent C. Dodds

๐Ÿ’ป ๐Ÿ“– ๐Ÿš‡

Jonathan Haines

๐Ÿ’ป

Zack Yang

๐Ÿ’ป

Mohamed Oun

๐Ÿ’ป

Alexander Nanberg

๐Ÿ’ป

Hu Chen

๐Ÿ’ป

Weyert de Boer

๐Ÿ’ป

Marko Vujanic

๐Ÿ’ป

Michaรซl De Boey

๐Ÿ’ป ๐Ÿ“– ๐Ÿ”ง

Justin Dorfman

๐Ÿ“–

Nikolay Stoynov

๐Ÿ“–

Andrew Mason

๐Ÿ“–

Ben Monro

๐Ÿ’ป

Silviu Alexandru Avram

๐Ÿ“–

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

LICENSE

MIT