🐇 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 bundled extends you don't want
  disableExtends: ["eslintReact", "eslintA11y", "eslintStorybook"],

  // 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
  },
});

Both options are independent — pass either, both, or neither.

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

eslintA11y · eslintPerfectionist · eslintPrettier · eslintReact · eslintStorybook · eslintTesting · eslintTypescript · eslintUnicorn

🧩 What’s Included?

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

Plugins

• eslint-plugin-react ⚛️ — React best practices
• eslint-plugin-jsx-a11y ♿️ — Accessibility rules for JSX
• eslint-plugin-testing-library 🧪 — Testing Library linting
• eslint-plugin-storybook 📖 — Storybook linting
• eslint-plugin-prettier 🎨 — Run Prettier as an ESLint rule
• eslint-plugin-perfectionist 🪄 — Enforces sorting and consistency
• eslint-plugin-unicorn 🦄— Massive rules for good code

🤝 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