@matali/eslint-config
Personal, shareable ESLint configuration for TypeScript and Next.js projects.
Features
- Autofixable sorting of:
- destructured object keys,
-
imports
including folders inside of
/src
directory, - interface and type keys,
- object keys,
- React props.
- Autofixable removal of unused imports.
- Prettier compatibility.
- Recommended ESLint, Next.js and typescript-eslint rules.
Installation
npm install --save-dev @matali/eslint-config @typescript-eslint/parser eslint typescript
yarn add --dev @matali/eslint-config @typescript-eslint/parser eslint typescript
pnpm add --save-dev @matali/eslint-config @typescript-eslint/parser eslint typescript
Usage
Specify the parser for TypeScript files in your .eslintrc.*
configuration
file, provide a path to your project's tsconfig.json
and add @matali
to the
extends
array.
{
"extends": ["@matali"],
"parser": "@typescript-eslint/parser",
"parserOptions": {
"project": "./tsconfig.json"
}
}
In Next.js projects extend @matali/eslint-config/next
instead.
{
"extends": ["@matali/eslint-config/next"],
"parser": "@typescript-eslint/parser",
"parserOptions": {
"project": "./tsconfig.json"
}
}
Authors
- Mateusz Aliyev (@mateuszaliyev)