@kachkaev → eslint config (base)

A collection of carefully picked ESLint rules and plugins for TypeScript projects.

Compatible with ESLint v9+ (Flat config). Requires TypeScript to be present as a dependency.

See also @kachkaev/eslint-config-next.

Principles

This configuration uses warnings for rules that are related to code style (the ones that are not likely to prevent runtime errors), and errors otherwise. This looks less noisy than using errors for all rules. Both severity levels fail CI when eslint is called with --max-warnings=0.

It is assumed that all files are written in TypeScript and use ESM (not CommonJS).

Adding to project

1. Ensure your package.json contains "type": "module".

2. Ensure your project has a tsconfig.json file.

3. Install these packages as dev dependencies:

   ## If you use NPM
   npm install -D eslint @kachkaev/eslint-config-base
       
   ## If you use PNPM
   pnpm add -D eslint @kachkaev/eslint-config-base
       
   ## If you use Yarn
   yarn add -D eslint @kachkaev/eslint-config-base

   If you don't keep your Node.js runtime up-to-date, you might need to install jiti to enable *.ts files -- see ESLint docs for details.

4. Create eslint.config.ts with the following contents:

   import { defineConfig } from "eslint/config";
   import { generateBaseConfigs } from "@kachkaev/eslint-config-base";
   
   export default defineConfig([
     ...generateBaseConfigs(),
   
     // ... Place additional configs here if needed ...
   ]);

   If you work in a monorepo, you may need to specify tsconfigRootDir for some rules to work correctly:

   - generateBaseConfigs();
   + generateBaseConfigs({ tsconfigRootDir: import.meta.dirname });

5. Add package.json scripts:

   {
     "...": "...",
     "scripts": {
       "...": "...",
       "fix:eslint": "eslint --max-warnings=0 --fix",
       "...": "...",
       "lint:eslint": "eslint --max-warnings=0",
       "...": "..."
     }
   }

You can now run [npm/pnpm/yarn] run fix:eslint to lint your code and [npm/pnpm/yarn] run lint:eslint to fix linting errors.