Getting Started

This library is a DX-first, composable ESLint 10+ flat-config toolkit for JavaScript and TypeScript teams. In v2, application projects install @santi020k/eslint-config-basic and enable bundled framework configs directly from it.

Requirements

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

Setup Process

1. Install the Base Package

   The smallest install is the main package itself. It brings a supported ESLint version automatically.

   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

2. Create Configuration File

   Create an eslint.config.mjs file, or eslint.config.js if your project uses "type": "module".

   eslint.config.mjs

   import { defineConfig } from '@santi020k/eslint-config-basic'
   
   export default await defineConfig()

Understand the Architecture

Unified Entry

@santi020k/eslint-config-basic is the main package. You no longer need to install framework configs directly.

Enum-based Toggles

Integrations can be enabled through enums, matching strings, or the simple features map.

Flexible Versions

ESLint can still be installed manually if you want to pin it yourself, as long as you stay on ^10.

Pick the Right Starting Point

Use the links below to navigate based on your immediate needs:

• Configuration: When you want to compose the config manually.
• CLI: When you want a generated starting file.
• Frameworks: When you already know the application stack.
• Integrations: When the main need is integrating Tailwind, Vitest, Prettier, or similar packages.
• Packages: When you want to understand how the monorepo is organized.

Next Steps

• Continue with Detailed Installation
• Review Configuration Options
• Use the CLI generator if you want scaffolding
• Jump to Framework Guides