Skip to content

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

Notifications You must be signed in to change notification settings

sebastian-software/effective-eslint-cfg

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ESLint Config Builder

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

import { createConfig } from "@effective/eslint-cfg";

const config = createConfig({
  react: true,
  strict: true,
  style: true,
  biome: false,
});

// Output the generated configuration
console.log(config);

Build

pnpm run build

About

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

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published