Getting Started

This library is a DX-first, composable ESLint 9/10+ flat-config toolkit for JavaScript and TypeScript teams. The main entry point is @santi020k/eslint-config-basic, and framework packages are added explicitly only when the project actually needs them.

Requirements

• Node.js >=22.12.0
• ESLint 9+

Install the Base Package

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

pnpm

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

npm

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

yarn

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

bun

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

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

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

export default eslintConfig()

Understand the Package Layout

• @santi020k/eslint-config-basic is the main package.
• Framework packages such as React, Next.js, Astro, Vue, and NestJS are installed only when needed.
• Optional integrations are enabled through enums from the main package instead of separate config objects in application code.
• ESLint can still be installed manually if you want to pin it yourself, as long as you stay on a compatible ^9 or ^10 release.

Choose Your Workflow

• Use the base package alone for core JavaScript, TypeScript, runtime detection, and optional integrations.
• Add framework packages like React, Next.js, Astro, or Vue when your project needs them.
• Use the CLI if you want a scaffolded config with detected integrations.

Pick the Right Starting Point

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

Canonical Package Entry Points

• Main package: @santi020k/eslint-config-basic
• Repo: santi020k/eslint-config-basic
• Author: santi020k

Next Steps

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