@code-pushup/eslint-config


Recommended ESLint presets by Code PushUp.

⚙️ Configs

| Stack | Config | Description |
| :--------------------------------------------------------: | :------------------------------------------------------- | :------------------------------------------------------------------ |
| !javascript | javascript | Default config, suitable for any JavaScript/TypeScript project. |
| !typescript | typescript | Config for strict TypeScript projects. |
| !nodejs | node | Config for Node.js projects. |
| !angular | angular | Config for Angular projects. |
| !ngrx | ngrx | Config for Angular projects using NgRx library. |
| !react | react | Config for React projects. |
| !graphql | graphql | Config for GraphQL servers implemented in Node.js. |
| !jest | jest | Config for projects using Jest for testing. |
| !vitest | vitest | Config for projects using Vitest for testing. |
| !cypress | cypress | Config for projects using Cypress for testing. |
| !playwright | playwright | Config for projects using Playwright for testing. |
| !storybook | storybook | Config for projects using Storybook for UI components. |
| !testing-library | react-testing-library | Config for projects using React Testing Library for testing. |

Some configs extend other configs, as illustrated below. So, for example, extending angular config implicitly extends typescript and javascript configs as well.

``mermaid
graph BT;
typescript --extends--> javascript
node --extends--> javascript
angular --extends--> typescript
ngrx --extends--> angular
react --extends--> javascript
graphql --extends--> node
`

$3

To use the default config, follow these steps:

1. You must first install all the required peer dependencies (if you haven't already):

`sh
npm install -D eslint @eslint/js eslint-plugin-{functional,import,promise,sonarjs,unicorn} globals typescript-eslint
`

2. Install @code-pushup/eslint-config with:

`sh
npm install -D @code-pushup/eslint-config
`

3. Include default config in your ESLint configuration file (usually eslint.config.js):

`js
import javascript from '@code-pushup/eslint-config/javascript.js';
import { defineConfig } from 'eslint/config';

export default defineConfig(...javascript);
`

Depending on your tech stack, you may wish to extend other configs as well (listed above). This will require installing additional peer dependencies. For more details, refer to setup docs for the configs you're interested in using.

#### 📦 Peer dependencies

All peer dependencies used by @code-pushup/eslint-config are listed below, along with their supported versions. Only the default config's dependencies are required, others are optional.

| | NPM package | Version | Required |
| :--------------------------------------------------------: | :--------------------------------------------------------------------------------------------------- | :----------------------------------------------: | :------: |
| !eslint | eslint | ^9.0.0 | ✅ |
| !eslint | @eslint/js | ^9.0.0 | ✅ |
| !lambda | eslint-plugin-functional | ^7.0.0 \|\| ^8.0.0 \|\| ^9.0.0 | ✅ |
| !import | eslint-plugin-import | ^2.31.0 | ✅ |
| !import | eslint-import-resolver-typescript | ^3.0.0 \|\| ^4.0.0 | |
| !promise | eslint-plugin-promise | >=6.4.0 | ✅ |
| !sonar | eslint-plugin-sonarjs | ^1.0.4 | ✅ |
| !unicorn | eslint-plugin-unicorn | >=50.0.0 | ✅ |
| !global | globals | >=14.0.0 | ✅ |
| !typescript | typescript-eslint | ^8.0.0 | ✅ |
| !graphql | @graphql-eslint/eslint-plugin | ^3.0.0 \|\| ^4.0.0 | |
| !ngrx | @ngrx/eslint-plugin | ^18.0.0 \|\| ^19.0.0 \|\| ^20.0.0 \|\| ^21.0.0 | |
| !vitest | @vitest/eslint-plugin | ^1.1.9 | |
| !angular | angular-eslint | ^18.0.0 \|\| ^19.0.0 \|\| ^20.0.0 \|\| ^21.0.0 | |
| !cypress | eslint-plugin-cypress | >=3.3.0 | |
| !jest | eslint-plugin-jest | ^28.8.0 \|\| ^29.0.0 | |
| !accessibility | eslint-plugin-jsx-a11y | ^6.10.0 | |
| !nodejs | eslint-plugin-n | >=17.0.0 | |
| !playwright | eslint-plugin-playwright | ^2.1.0 | |
| !react | eslint-plugin-react | ^7.36.0 | |
| !react_ts | eslint-plugin-react-hooks | >=5.0.0 | |
| !rxjs | eslint-plugin-rxjs-x | >=0.6.0 | |
| !storybook | eslint-plugin-storybook | >=0.10.0 | |
| !testing-library | eslint-plugin-testing-library | ^7.1.1 | |

$3

For non-production code, some rules are disabled (or downgraded from errors to warnings).

This applies to file paths matching any of the following globs:

- */.spec.?(c|m)[jt]s?(x)
- */.test.?(c|m)[jt]s?(x)
- /__tests__//*.?(c|m)[jt]s?(x)
- /__mocks__//*.?(c|m)[jt]s?(x)
- */.cy.?(c|m)[jt]s?(x)
- */.stories.?(c|m)[jt]s?(x)
- */.e2e.?(c|m)[jt]s?(x)
- */.mock.?(c|m)[jt]s?(x)
- */.mocks.?(c|m)[jt]s?(x)
- /test//*.?(c|m)[jt]s?(x)
- /tests//*.?(c|m)[jt]s?(x)
- /mocks//*.?(c|m)[jt]s?(x)
- /testing-utils//*.?(c|m)[jt]s?(x)
- /test-utils//*.?(c|m)[jt]s?(x)
- /fixtures//*.?(c|m)[jt]s?(x)
- */.config.?(c|m)[jt]s
- **/.prettierrc.?(c|m)[jt]s
- **/codegen.?(c|m)[jt]s
- **/test-setup.?(c|m)[jt]s

🫴 Contributing

Node.js installation is a prerequisite (LTS version). Install dependencies with NPM:

`sh
npm install
`

To execute tests:

`sh
npm test
`

To generate documentation:

`sh
npm run docs
``