@aivenio/eslint-config-aiven v7.1.4
eslint-config-aiven
Our internal ESLint and prettier configuration. We want to autoformat code like prettier does, but also do more static checks that eslint does. To do both, we use eslint-plugin-prettier and eslint acts as the frontend to check and autofix style and other issues.
The configuration is split into:
@aivenio/eslint-config-aiven
- Recommended base configuration for TypeScript.
@aivenio/eslint-config-aiven/react
- Base + React additions.
@aivenio/eslint-config-aiven/typescript-type-checked
- Base + TS rules that require typed linting
Install recommended base
npm install @aivenio/eslint-config-aiven
Create an .eslintrc file to your repository root and select which configuration to use:
{ "extends": ["@aivenio/eslint-config-aiven"] // "extends": ["@aivenio/eslint-config-aiven/react", "@aivenio/eslint-config-aiven/typescript-type-checked"] }
When using
eslint-config-aiven/react
, install the required peer dependencies:eslint-plugin-react
,eslint-plugin-react-hooks
andeslint-plugin-jsx-a11y
.Setup npm scripts in package.json
"eslint:fix": "eslint --config .eslintrc --fix \"src/**/*.{ts,tsx}\"", "eslint:check": "eslint --config .eslintrc \"src/**/*.{ts,tsx}\"",
Remember to setup a CI task to lint source code. See .github/workflows/test.yml for a GH action example.
Install for React
Follow all steps in "Install recommended base" first
Install additional peer dependencies
npm i --save-dev eslint-plugin-jsx-a11y npm i --save-dev eslint-plugin-react
Change the .eslintrc in your repository to have the following contents:
{ "extends": ["@aivenio/eslint-config-aiven/react"] }
4 months ago
4 months ago
4 months ago
5 months ago
6 months ago
10 months ago
7 months ago
7 months ago
11 months ago
11 months ago
11 months ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
4 years ago
4 years ago
4 years ago