Skip to content

CLI

The main package ships a CLI that can scaffold or refresh the project config.

sh
pnpm dlx @santi020k/eslint-config-basic init
pnpm dlx @santi020k/eslint-config-basic update
sh
npx @santi020k/eslint-config-basic init
npx @santi020k/eslint-config-basic update
sh
yarn dlx @santi020k/eslint-config-basic init
yarn dlx @santi020k/eslint-config-basic update
sh
bunx @santi020k/eslint-config-basic init
bunx @santi020k/eslint-config-basic update

What It Does

  • Detects TypeScript, runtime, and supported optional integrations from package.json.
  • Chooses eslint.config.js for ESM projects.
  • Chooses eslint.config.mjs otherwise.
  • Includes explicit framework imports in generated configs.
  • Adds React automatically when Next.js or Expo is detected.

Usage

sh
pnpm dlx @santi020k/eslint-config-basic init
sh
npx @santi020k/eslint-config-basic init
sh
yarn dlx @santi020k/eslint-config-basic init
sh
bunx @santi020k/eslint-config-basic init

If the package is already installed locally, the basic-eslint bin is also available through your package manager's local binary resolution.

Update an Existing Config

sh
pnpm dlx @santi020k/eslint-config-basic update
sh
npx @santi020k/eslint-config-basic update
sh
yarn dlx @santi020k/eslint-config-basic update
sh
bunx @santi020k/eslint-config-basic update

Use update when you want to regenerate the file after adding or removing dependencies.

When to Use Each Command

  • Use init when the project does not have an ESLint flat config yet.
  • Use update when the dependency graph changed and you want a fresh generated baseline.
  • Use manual editing when the config already has custom organization that you do not want regenerated.

Why the Generated Config Stays Explicit

The CLI is the bridge between detection and maintainable source code. Detection can infer that a project uses Next.js or Astro, but the generated file still writes explicit imports so your config remains readable and reviewable.

Notes

  • The CLI detects frameworks, but it does not hide them behind implicit runtime magic.
  • Existing eslint.config.js or eslint.config.mjs files are respected for updates.
  • The generated file is a starting point that you can still edit by hand.

Documentation site v1.3.0 for @santi020k/eslint-config-basic