Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kentcdodds/eslint-config-kentcdodds
ESLint configuration for projects that I do... Feel free to use this!
https://github.com/kentcdodds/eslint-config-kentcdodds
eslint-config personal-config
Last synced: 5 days ago
JSON representation
ESLint configuration for projects that I do... Feel free to use this!
- Host: GitHub
- URL: https://github.com/kentcdodds/eslint-config-kentcdodds
- Owner: kentcdodds
- License: mit
- Created: 2015-08-27T12:20:05.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2024-01-03T23:52:28.000Z (11 months ago)
- Last Synced: 2024-11-30T18:04:30.791Z (12 days ago)
- Topics: eslint-config, personal-config
- Language: JavaScript
- Homepage: http://eslint.org/docs/user-guide/configuring#extending-configuration-files
- Size: 289 KB
- Stars: 340
- Watchers: 13
- Forks: 65
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-github-star - eslint-config-kentcdodds
README
eslint-config-kentcdodds
ESLint 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]
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Other configs](#other-configs)
- [Things to know](#things-to-know)
- [Issues](#issues)
- [🐛 Bugs](#-bugs)
- [💡 Feature Requests](#-feature-requests)
- [Contributors ✨](#contributors-)
- [LICENSE](#license)
## Installation
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]
## Usage
Then add the extends to your `.eslintrc.js`:
```javascript
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:
```javascript
module.exports = {
extends: 'kentcdodds/',
}
```
Or in combination with the base config (recommended)
```javascript
module.exports = {
extends: ['kentcdodds', 'kentcdodds/'],
}
```
### 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
```javascript
module.exports = {
extends: ['kentcdodds/import', 'kentcdodds/jest'],
rules: {
/* custom rules */
},
}
```
## Issues
_Looking to contribute? Look for the [Good First Issue][good-first-issue]
label._
### 🐛 Bugs
Please file an issue for bugs, missing documentation, or unexpected behavior.
[**See Bugs**][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**][requests]
## Contributors ✨
Thanks goes to these people ([emoji key][emojis]):
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][all-contributors] specification.
Contributions of any kind welcome!
## LICENSE
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