Skip to content

Installation

Requirements

  • Node.js >=18.18.0
  • ESLint 10+

Base Package

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

Framework Packages

Install framework packages only when your project needs them.

bash
npm install -D @santi020k/eslint-config-react
npm install -D @santi020k/eslint-config-next
npm install -D @santi020k/eslint-config-astro
npm install -D @santi020k/eslint-config-vue

Other supported packages are documented in the Framework guides.

Framework Installation Matrix

Project TypePackages To InstallNotes
TypeScripteslint, @santi020k/eslint-config-basicTypeScript is enabled with typescript: true and is auto-detected from tsconfig.json.
Reacteslint, @santi020k/eslint-config-basic, @santi020k/eslint-config-reactCommon browser setup.
Next.jseslint, @santi020k/eslint-config-basic, @santi020k/eslint-config-next, @santi020k/eslint-config-reactReact is required.
Astroeslint, @santi020k/eslint-config-basic, @santi020k/eslint-config-astroCommonly paired with TypeScript.
Vueeslint, @santi020k/eslint-config-basic, @santi020k/eslint-config-vueSupports single-file components.
Svelteeslint, @santi020k/eslint-config-basic, @santi020k/eslint-config-svelteCommonly paired with TypeScript.
Solideslint, @santi020k/eslint-config-basic, @santi020k/eslint-config-solidCombine with TypeScript as needed.
Angulareslint, @santi020k/eslint-config-basic, @santi020k/eslint-config-angularUsually paired with TypeScript.
NestJSeslint, @santi020k/eslint-config-basic, @santi020k/eslint-config-nestCommonly paired with Preset.Node or Runtime.Node.
Expoeslint, @santi020k/eslint-config-basic, @santi020k/eslint-config-expo, @santi020k/eslint-config-reactReact is required.

Optional Tooling Matrix

CategoryConfigure ThroughDocumentation
LibrarieslibrariesLibraries
TestingtestingTesting
FormatsformatsFormats
ToolstoolsTools
ExtensionsextensionsExtensions

Minimal Config

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

export default eslintConfig()

Common Installation Paths

  • Base JavaScript or TypeScript only: Install eslint and @santi020k/eslint-config-basic.
  • React projects: Add @santi020k/eslint-config-react.
  • Next.js projects: Add both @santi020k/eslint-config-next and @santi020k/eslint-config-react.
  • Expo projects: Add both @santi020k/eslint-config-expo and @santi020k/eslint-config-react.
  • Other frameworks: Add the specific framework package only when it is needed by the project.

React Example

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

export default eslintConfig({
  typescript: true,
  frameworks: {
    react
  }
})

Notes

  • TypeScript, runtime, and supported optional integrations can be detected automatically from package.json.
  • Framework configs stay explicit on purpose.
  • Next.js and Expo require the React package as part of the frameworks object.

Built by Santi020k. Repo and personal site linked throughout the docs.