@lzear/eslint-config

Shared ESLint flat config for lzear repos. Includes rules for TypeScript, React, Node, Vitest, imports, accessibility, and more.

Install

npm install -D @lzear/eslint-config eslint
# or
yarn add -D @lzear/eslint-config eslint

Requires Node ≥ 20, ESLint ≥ 9.

Usage

Minimal eslint.config.ts:

import lzearConfig from '@lzear/eslint-config'

export default await lzearConfig()

With options — disable feature sets you don't use:

import lzearConfig from '@lzear/eslint-config'

export default await lzearConfig({
  react: false,   // not a React project
  vitest: false,  // no tests
})

| Option | Default | Description | |--------------|---------|------------------------------------------| | typescript | true | TypeScript rules via typescript-eslint | | react | true | React, hooks, a11y, compiler rules | | node | true | Node.js rules via eslint-plugin-n | | vitest | true | Vitest rules via @vitest/eslint-plugin |

Extend with extra rules, overrides, and ignores:

import type { Linter } from 'eslint'
import lzearConfig from '@lzear/eslint-config'

const base = await lzearConfig({ react: false })

const config: Linter.Config[] = [
  ...base,

  // Extra rules applied to all files
  {
    rules: {
      'no-console': 'error',
      'unicorn/filename-case': ['error', { case: 'kebabCase' }],
    },
  },

  // Turn off or downgrade specific rules
  {
    rules: {
      'sonarjs/cognitive-complexity': 'off',
      'import-x/order': 'warn',
    },
  },

  // Override rules for specific files
  {
    files: ['scripts/**/*.ts'],
    rules: {
      'no-console': 'off',
      'unicorn/no-process-exit': 'off',
    },
  },

  // Ignore generated files and specific folders
  {
    ignores: [
      'src/generated/**',
      'public/**',
      '**/*.min.js',
    ],
  },
]

export default config

Included plugins

@eslint/js · typescript-eslint · eslint-plugin-unicorn · eslint-plugin-sonarjs · eslint-plugin-import-x · eslint-plugin-promise · eslint-plugin-regexp · eslint-plugin-react · eslint-plugin-react-hooks · eslint-plugin-jsx-a11y · eslint-plugin-n · @vitest/eslint-plugin · eslint-plugin-package-json · eslint-config-prettier · and more.

Part of forge

This package is part of forge — shared dev tooling for lzear repos.