Installation

Requirements

• Node.js ^20.19.0 || >=22.18.0
• ESLint 10+

Compatibility Matrix

Runtime	Supported Version	Notes
Node.js	^20.19.0 || >=22.18.0	Required by the published packages and CI matrix.
ESLint	^10.0.0	The current release line targets ESLint 10 flat config.
TypeScript	>=5.0.0	Optional unless typescript linting is enabled.
Package managers	pnpm, npm, yarn, bun	CI validates package artifacts; consumer e2e tests load the built package from outside the repo.

Install

In v2, application projects install one public package:

pnpmnpmYarnBun

bash

pnpm add -D @santi020k/eslint-config-basic

bash

npm install -D @santi020k/eslint-config-basic

bash

yarn add -D @santi020k/eslint-config-basic

bash

bun add -d @santi020k/eslint-config-basic

That package brings the framework config packages used by the composer. You no longer install @santi020k/eslint-config-react, @santi020k/eslint-config-next, or another framework config package in normal application projects.

Dependency Policy

The full package intentionally installs the framework config packages and integration plugin set as regular dependencies. This keeps app installs boring: one package, one tested dependency graph, and no peer-dependency puzzle for every framework.

The integration package also carries compatible runtime peers for bundled plugins that can be satisfied safely inside the package, including Tailwind, Zod, and GraphQL. Some third-party ESLint plugins may still publish peer ranges that lag behind ESLint 10 or TypeScript 6; those warnings are upstream compatibility metadata rather than missing project setup.

Unused framework configs are lazy-loaded only when enabled or detected. They still affect disk usage, but not lint-time imports. For dependency-sensitive projects, use @santi020k/eslint-config-lite and install only the framework/integration packages you enable.

Lite Install

If your project needs a smaller install or wants to manage framework config packages manually, use the optional lite entry point:

pnpmnpmYarnBun

bash

pnpm add -D @santi020k/eslint-config-lite eslint

bash

npm install -D @santi020k/eslint-config-lite eslint

bash

yarn add -D @santi020k/eslint-config-lite eslint

bash

bun add -d @santi020k/eslint-config-lite eslint

import { defineConfig } from '@santi020k/eslint-config-lite'

export default await defineConfig()

With @santi020k/eslint-config-lite, install framework and integration config packages only when you enable them:

pnpmnpmYarnBun

bash

pnpm add -D @santi020k/eslint-config-react @santi020k/eslint-config-integrations

bash

npm install -D @santi020k/eslint-config-react @santi020k/eslint-config-integrations

bash

yarn add -D @santi020k/eslint-config-react @santi020k/eslint-config-integrations

bash

bun add -d @santi020k/eslint-config-react @santi020k/eslint-config-integrations

The full @santi020k/eslint-config-basic package remains the recommended default. Use lite for dependency-sensitive projects and CI caches where manual package ownership is worth the extra setup.

Option	Best For	Dependency Model
@santi020k/eslint-config-basic	Most application projects	Full tested stack is installed together.
@santi020k/eslint-config-lite	Dependency-sensitive projects and tight CI caches	Core composer by default; framework and integration config packages are manual.
Individual @santi020k/eslint-config-* packages	Advanced custom composition	You assemble imported configs yourself.

For an existing project, basic-eslint doctor --lite-install prints the lite install command from detected project features.

Minimal Config

import { defineConfig } from '@santi020k/eslint-config-basic'

export default await defineConfig()

The composer detects TypeScript, frameworks, runtime, and supported optional tooling from your project. You can keep the config minimal or make any choice explicit.

Optional Features

When auto-detection is not enough, optional configs can be enabled by category arrays or by the simple features map.

import { defineConfig } from '@santi020k/eslint-config-basic'

export default await defineConfig({
  features: {
    playwright: true,
    prettier: true,
    tailwind: true,
    zod: true
  }
})

The category arrays also accept enum values or their matching strings:

import { defineConfig, Library, Tool } from '@santi020k/eslint-config-basic'

export default await defineConfig({
  libraries: [Library.Tailwind, 'zod'],
  tools: [Tool.Prettier, 'cspell']
})

Explicit Frameworks

Use booleans when you want to enable framework configs manually:

import { defineConfig } from '@santi020k/eslint-config-basic'

export default await defineConfig({
  frameworks: {
    next: true,
    react: true
  },
  typescript: true
})

Next.js, Expo, and Remix automatically include React rules when needed.

Ignoring paths

Skip linting build artifacts or generated folders by passing ignores on eslintConfig()—same effect as a leading flat-config block that only sets ignores, without wrapping the export in an extra array.

import { defineConfig } from '@santi020k/eslint-config-basic'

export default await defineConfig({
  ignores: ['dist/**', 'coverage/**']
})

See Configuration for presets, monorepo projects, and ESLint working-directory notes.

Framework Matrix

Project Type	Package To Install	Enable With
JavaScript	@santi020k/eslint-config-basic	eslintConfig()
JavaScript, manual packages	@santi020k/eslint-config-lite	eslintConfig()
TypeScript	@santi020k/eslint-config-basic	typescript: true or auto-detection
React	@santi020k/eslint-config-basic	frameworks.react: true
Next.js	@santi020k/eslint-config-basic	frameworks.next: true
Astro	@santi020k/eslint-config-basic	frameworks.astro: true
Vue	@santi020k/eslint-config-basic	frameworks.vue: true
Svelte	@santi020k/eslint-config-basic	frameworks.svelte: true
Solid	@santi020k/eslint-config-basic	frameworks.solid: true
Angular	@santi020k/eslint-config-basic	frameworks.angular: true
NestJS	@santi020k/eslint-config-basic	frameworks.nest: true
Hono	@santi020k/eslint-config-basic	frameworks.hono: true
Preact	@santi020k/eslint-config-basic	frameworks.preact: true
Qwik	@santi020k/eslint-config-basic	frameworks.qwik: true
Remix	@santi020k/eslint-config-basic	frameworks.remix: true
Expo	@santi020k/eslint-config-basic	frameworks.expo: true
Vite	@santi020k/eslint-config-basic	frameworks.vite: true
Slidev	@santi020k/eslint-config-basic	frameworks.slidev: true

Integrations

Optional integrations still use the same categories:

Category	Configure Through	Documentation
Libraries	libraries	Libraries
Testing	testing	Testing
Formats	formats	Formats
Tools	tools	Tools
Extensions	extensions	Extensions

Use features or its alias integrations when you prefer one boolean map instead of separate category arrays.

Migration

If you are upgrading from v1, read the v1 to v2 migration guide. The short version is: remove extra @santi020k/eslint-config-* framework installs from your app and replace imported framework values with true.