🐇 ESLint Config – @the-rabbit-hole

✨ Overview

This package provides a shared ESLint configuration used across all
@the-rabbit-hole projects.

It is designed to be:

• 🛠 Reusable – a single config for all JS/TS projects
• 📦 Pluggable – easy to extend if needed
• 🌍 Publicly available – you can use it in your own projects too!

📦 Installation

# with npm
npm install --save-dev eslint @the-rabbit-hole/eslint-config

# with yarn
yarn add -D eslint @the-rabbit-hole/eslint-config

# with pnpm
pnpm add -D eslint @the-rabbit-hole/eslint-config

⚙️ Usage

In your eslint.config.js (or eslint.config.mjs):

import eslintConfig from "@the-rabbit-hole/eslint-config";
export default eslintConfig;

That’s it! 🚀

🛠 Customizing

Use the named createESLintConfig factory to disable bundled extends, add new rules, or override the package's defaults:

import { createESLintConfig } from "@the-rabbit-hole/eslint-config";

export default createESLintConfig({
  // Drop default-on extends you don't want
  disableExtends: ["eslintReact"],

  // Turn on opt-in extends that are off by default
  enable: ["eslintA11y", "eslintTypedoc"],

  // Add your own rules — or override bundled ones
  rules: {
    "no-console": "error",                // additive — applied as-is
    "react/react-in-jsx-scope": "warn",   // overrides the bundled default
  },
});

All options are independent — pass any combination, or none.

Override notifications

If a key in rules matches a rule the package sets by default, an info line is printed when ESLint loads the config so the override is visible:

[@the-rabbit-hole/eslint-config] Rule "react/react-in-jsx-scope" overrides the bundled default.

Adding rules the package does not set is silent — no message.

Available disableExtends keys (default-on extends)

eslintPerfectionist · eslintPrettier · eslintReact · eslintTypescript · eslintUnicorn

Opt-in extends (enable)

These are off by default and only applied when named in enable. They target a specific kind of project rather than every consumer, so a plain Node library never inherits rules it has no use for:

• eslintA11y — JSX accessibility rules (eslint-plugin-jsx-a11y), for React component code.
• eslintStorybook — Storybook story linting (eslint-plugin-storybook).
• eslintTesting — Testing Library rules (eslint-plugin-testing-library), for test files.
• eslintTypedoc — TypeDoc/TSDoc documentation quality (eslint-plugin-typedoc): doc-comment coverage on exported APIs (typedoc/require-exported-doc-comment) plus tag correctness (unknown/duplicate/empty tags, malformed inline links). Scoped to **/*.{ts,tsx,mts,cts}.

import { createESLintConfig } from "@the-rabbit-hole/eslint-config";

// A React component library that wants a11y, Storybook, and doc-coverage:
export default createESLintConfig({
  enable: ["eslintA11y", "eslintStorybook", "eslintTypedoc"],
});

Upgrading from 0.4.x: eslintA11y, eslintTesting, and eslintStorybook used to be on by default. They are now opt-in — add them to enable (and remove them from disableExtends) if your project relied on them.

🧩 What’s Included?

This ESLint config comes pre-bundled with a set of plugins and shareable configs tailored for modern TypeScript + React projects:

Default plugins (on by default)

• eslint-plugin-react ⚛️ — React best practices
• eslint-plugin-prettier 🎨 — Run Prettier as an ESLint rule
• eslint-plugin-perfectionist 🪄 — Enforces sorting and consistency
• eslint-plugin-unicorn 🦄— Massive rules for good code
• typescript-eslint 🟦 — TypeScript linting

Opt-in plugins (enable)

• eslint-plugin-jsx-a11y ♿️ — Accessibility rules for JSX (enable: ["eslintA11y"])
• eslint-plugin-testing-library 🧪 — Testing Library linting (enable: ["eslintTesting"])
• eslint-plugin-storybook 📖 — Storybook linting (enable: ["eslintStorybook"])
• eslint-plugin-typedoc 📚 — TypeDoc/TSDoc documentation quality (enable: ["eslintTypedoc"])

🎨 A note on Prettier

eslint-plugin-prettier runs Prettier as an ESLint rule, so the Prettier version decides the formatting. To keep prettier/prettier verdicts deterministic, this package ships Prettier as a pinned, exact dependency rather than a floating peer — the formatter engine only changes in an intentional, changelogged release. You do not need to install or pin Prettier yourself; remove any prettier peer expectation you previously satisfied for this config.

🤝 Contributing

Contributions are welcome! If you have suggestions, improvements, or run into issues, please open a PR or issue.

📜 License

This project is licensed under the MIT License. You’re free to use it in your own public or private projects.

Made with ❤️ by @the-rabbit-hole