Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexilyaev/eslint-config-ai
An opinionated set of ESLint shareable configs by Alex Ilyaev
https://github.com/alexilyaev/eslint-config-ai
eslint eslint-config
Last synced: 28 days ago
JSON representation
An opinionated set of ESLint shareable configs by Alex Ilyaev
- Host: GitHub
- URL: https://github.com/alexilyaev/eslint-config-ai
- Owner: alexilyaev
- License: mit
- Created: 2018-06-12T13:10:56.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-08-19T17:16:28.000Z (3 months ago)
- Last Synced: 2024-09-25T00:07:45.163Z (about 1 month ago)
- Topics: eslint, eslint-config
- Language: JavaScript
- Homepage:
- Size: 489 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# eslint-config-ai
> An opinionated set of ESLint [shareable configs](http://eslint.org/docs/developer-guide/shareable-configs.html)
> by Alex Ilyaev
## Why?
I manage many projects and find myself copy/pasting configs between projects,
which got out of hand pretty quickly.
## What's included?
- `ai`
- [eslint:recommended](https://github.com/eslint/eslint/blob/main/packages/js/src/configs/eslint-recommended.js)
- Common base rules
- `ai/unicorn`
- [eslint-plugin-unicorn](https://github.com/sindresorhus/eslint-plugin-unicorn)
- `ai/import`
- [eslint-plugin-import](https://github.com/benmosher/eslint-plugin-import)
- `ai/jest`
- [eslint-plugin-jest](https://github.com/jest-community/eslint-plugin-jest)
- `ai/lodash`
- [eslint-plugin-lodash](https://github.com/wix/eslint-plugin-lodash)
- `ai/promise`
- [eslint-plugin-promise](https://github.com/xjamundx/eslint-plugin-promise)
- `ai/react`
- [eslint-plugin-react](https://github.com/yannickcr/eslint-plugin-react)
- Setting `react/recommended` and `react/jsx-runtime`
- [eslint-plugin-react-hooks](https://github.com/facebook/react/tree/master/packages/eslint-plugin-react-hooks)
- [eslint-plugin-jsx-a11y](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y)
- [eslint-plugin-compat](https://github.com/amilajack/eslint-plugin-compat)
- `ai/jsdoc`
- [eslint-plugin-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc)
- `ai/eslint-comments`
- [eslint-plugin-eslint-comments](https://github.com/mysticatea/eslint-plugin-eslint-comments)
- `ai/last`
- [@stylistic/disable-legacy](https://eslint.style/guide/migration#disable-legacy-rules)
- Disables styling rules that were deprecated and moved to `@stylistic`
- [prettier](https://github.com/prettier/eslint-config-prettier/tree/main)
- Disables styling rules that are covered by Prettier
## Installation
Required:
```shell
yarn add -D \
prettier \
eslint \
eslint-config-prettier \
@stylistic/eslint-plugin \
@typescript-eslint/eslint-plugin \
@typescript-eslint/parser \
eslint-config-ai
```
Optional (based on the configs you choose):
```shell
yarn add -D \
eslint-plugin-import \
eslint-import-resolver-typescript \
eslint-plugin-jest \
eslint-plugin-lodash \
eslint-plugin-promise \
eslint-plugin-jsdoc \
eslint-plugin-eslint-comments \
eslint-plugin-compat \
eslint-plugin-react \
eslint-plugin-react-hooks \
eslint-plugin-jsx-a11y \
eslint-plugin-unicorn
```
- If you use npm, replace `yarn add` with `npm install`
## Usage
Add to your [`.eslintrc`](http://eslint.org/docs/user-guide/configuring):
### Last
Disables styling rules that are covered by Prettier or deprecated and moved to
`@stylistic`
> Always add `ai/last` as the last `extends`
```json
{
"extends": ["ai/last"]
}
```
### Base rules
This config extends `eslint:recommended` and sets up Prettier
```json
{
"extends": ["ai", "ai/last"]
}
```
### Base + Plugins
You can choose which plugin to add
```json
{
"extends": [
"ai",
"ai/unicorn",
"ai/import",
"ai/jest",
"ai/lodash",
"ai/promise",
"ai/jsdoc",
"ai/eslint-comments",
"ai/last"
]
}
```
### Base + React
```json
{
"extends": ["ai", "ai/react", "ai/last"]
}
```
### All (Base + Plugins + React + Last)
```json
{
"extends": ["ai/all"]
}
```
## Configured Rules
You can see what's currently configured in these files:
- [base](./base.js)
- [unicorn](./unicorn.js)
- [import](./import.js)
- [jest](./jest.js)
- [lodash](./lodash.js)
- [promise](./promise.js)
- [jsdoc](./jsdoc.js)
- [eslint-comments](./eslint-comments.js)
- [react](./react.js)
- [last](./last.js)