https://github.com/10up/eslint-config
A shareable ESLint config.
https://github.com/10up/eslint-config
Last synced: 5 months ago
JSON representation
A shareable ESLint config.
- Host: GitHub
- URL: https://github.com/10up/eslint-config
- Owner: 10up
- Archived: true
- Created: 2016-11-11T19:17:11.000Z (over 8 years ago)
- Default Branch: trunk
- Last Pushed: 2021-05-05T00:29:03.000Z (about 4 years ago)
- Last Synced: 2024-07-24T16:10:51.735Z (11 months ago)
- Language: JavaScript
- Size: 83 KB
- Stars: 16
- Watchers: 93
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# 10up Eslint Config
**DEPRECATED.** Please go to https://github.com/10up/10up-toolkit
> ESLint [shareable config](https://github.com/10up/eslint-config)
[](#support-level)
[@10up/eslint-config](https://github.com/10up/eslint-config) is a shareable configuration package for [eslint](http://eslint.org) built on top of [eslint-airbnb-config](https://github.com/airbnb/javascript) and modified to meet 10up's own standards.
## Installation
1. Install all peer dependencies
```sh
npx install-peerdeps --dev @10up/eslint-config
```
2. Install [@10up/eslint-config](https://github.com/10up/eslint-config) as a development dependency of your project:
```sh
npm install @10up/eslint-config --save-dev
```
## Available ESLint configs
### @10up/eslint-config
The default export contains common rules that are not specific to any framework or environment.
```js
// eslintrc.js
module.exports = {
extends: ['@10up/eslint-config'],
};
```
### @10up/eslint-config/react
Extends `@10up/eslint-config` adding specific rules to React.
```js
// eslintrc.js
module.exports = {
extends: ['@10up/eslint-config/react'],
};
```
### @10up/eslint-config/wordpress
Extends `@10up/eslint-config/react` adding the custom gutenberg rules from `@wordpress/eslint-plugin`.
This rule requires installing the `@wordpress/eslint-plugin` package.
```sh
npm install --save-dev @wordpress/eslint-plugin
```
```js
// eslintrc.js
module.exports = {
extends: ['@10up/eslint-config/wordpress'],
};
```
### @10up/eslint-config/node
Extends `@10up/eslint-config` adding specific rules to Node.js.
```js
// eslintrc.js
module.exports = {
extends: ['@10up/eslint-config/node'],
};
```
### @10up/eslint-config/jest
Adds specific rules for the `jest` testing framework.
This rule requires installing `eslint-plugin-jest`
```sh
npm install --save-dev eslint-plugin-jest
```
```js
// eslintrc.js
module.exports = {
extends: ['@10up/eslint-config/react', '@10up/eslint-config/jest'],
};
```
### @10up/eslint-config/legacy
This legacy config contains only rules for ES5. It should be used for projects without babel that are still writing legacy JavaScript code.
```js
// eslintrc.js
module.exports = {
extends: ['@10up/eslint-config/legacy'],
};
```
## Usage
In order to use this config, choose the one you want and add this configuration to your `package.json`:
```json
{
"eslintConfig": {
"extends": "@10up/eslint-config"
}
}
```
Or add a `.eslintrc.js` file to your project root containing:
```js
module.exports = {
extends: ['@10up/eslint-config'],
};
```
## TypeScript Support
If you want TypeScript support, make sure to install `@typescript-eslint/eslint-plugin` and `@typescript-eslint/parser`
```sh
npm install --save-dev @typescript-eslint/eslint-plugin @typescript-eslint/parser
```
change the eslint parser to `@typescript-eslint/parser` and add the typescript plugin
```js
// eslintrc.js
module.exports = {
parser: '@typescript-eslint/parser',
extends: ['@10up/eslint-config/react'],
plugins: ['@typescript-eslint'],
}
```
## VSCode integration
We recommend turning on VSCode settings to automatically run `eslint --fix` on save.
```json
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true,
}
```
This will automagically format your code once you save. You don't need VSCode prettier extension enabled or running on save as eslint will automatically run `prettier` for you.
## Support Level
**Active:** 10up is actively working on this, and we expect to continue work for the foreseeable future including keeping tested up to the most recent version of WordPress. Bug reports, feature requests, questions, and pull requests are welcome.
## Like what you see?
