Skip to content

A TypeScript-based library for generating ESLint configurations in the Flat Config format, targeting React (optional) and TypeScript (mandatory) projects.

License

Notifications You must be signed in to change notification settings

sebastian-software/effective-eslint-cfg

Repository files navigation

ESLint Config Builder

Sponsored by License Version Build Downloads

A TypeScript-based library for generating ESLint configurations in the Flat Config format, targeting React (optional) and TypeScript (mandatory) projects.

Features

  • Generates ESLint Flat Configs for ESLint v9.
  • Supports TypeScript and optionally React and NodeJS
  • Config options:
    • strict: Enables stricter linting rules.
    • style: Adds additional rules for style guidelines.
  • Plugins for:
    • jsdoc: Typescript-aware JSDoc linting
    • react: Recommended checks from the react, hooks and compiler presets
    • regexp: Recommended mostly auto-fix rules for regular expressions
    • node: Recommended rules for development of ESM-enabled NodeJS scripts
  • Tweaks:
    • biome: Drop rules achievable by Biome
    • fast: Drop rules which require typing information (much faster)
  • Automatically drops rules handled by Prettier.

Installation

npm install @effective/eslint-cfg

Usage

// eslint.config.ts
import { getConfig } from "@effective/eslint-cfg"

const config = getConfig({
  react: true,
  strict: true,
  style: true
})

export default [
  {
    ignores: ["node_modules", "dist"]
  },
  {
    settings: {
      react: {
        version: "19.0"
      }
    }
  },
  {
    files: ["**/*.ts", "**/*.tsx"]
  },
  {
    rules: {
      // custom rules / overrides
    }
  }
]

Developer

Build

pnpm run build

License

Apache License; Version 2.0, January 2004

Copyright

Logo of Sebastian Software GmbH, Mainz, Germany

Copyright 2024-2025
Sebastian Software GmbH

About

A TypeScript-based library for generating ESLint configurations in the Flat Config format, targeting React (optional) and TypeScript (mandatory) projects.

Resources

License

Stars

Watchers

Forks

Packages

No packages published