@eslint/config-helpers

Description

Helper utilities for creating ESLint configuration.

Installation

For Node.js and compatible runtimes:

npm install @eslint/config-helpers
# or
yarn add @eslint/config-helpers
# or
pnpm install @eslint/config-helpers
# or
bun install @eslint/config-helpers

For Deno:

deno add @eslint/config-helpers

Usage

`defineConfig()`

The defineConfig() function allows you to specify an ESLint configuration with full type checking and additional capabilities, such as extends. Here's an example:

// eslint.config.js
import { defineConfig } from "@eslint/config-helpers";
import js from "@eslint/js";

export default defineConfig([
    {
        files: ["src/**/*.js"],
        plugins: { js },
        extends: ["js/recommended"],
        rules: {
            semi: "error",
            "prefer-const": "error",
        },
    },
    {
        files: ["test/**/*.js"],
        rules: {
            "no-console": "off",
        },
    },
]);

`globalIgnores()`

The globalIgnores() function allows you to specify patterns for files and directories that should be globally ignored by ESLint. This is useful for excluding files that you don't want to lint, such as build directories or third-party libraries. Here's an example:

// eslint.config.js
import { defineConfig, globalIgnores } from "@eslint/config-helpers";

export default defineConfig([
    {
        files: ["src/**/*.js"],
        rules: {
            semi: "error",
            "prefer-const": "error",
        },
    },
    globalIgnores(["node_modules/", "dist/", "coverage/"]),
]);