@favorodera/eslint-config 2.0.1 → 3.1.0

package/README.md

@@ -1,165 +1,103 @@
-<div align="center">
-  <h1>ESLint Config</h1>
-  <p><strong>Opinionated, type-safe flat ESLint configuration factory</strong></p>
-  <p>
-    <a href="https://github.com/favorodera/eslint-config/blob/main/LICENSE"><img src="https://img.shields.io/github/license/favorodera/eslint-config.svg?style=plastic&label=License&color=blue" alt="License"></a>
-    <a href="https://github.com/favorodera/eslint-config/stargazers"><img src="https://img.shields.io/github/stars/favorodera/eslint-config.svg?style=plastic&label=Stars&color=blue" alt="GitHub Stars"></a>
-    <a href="https://npmx.dev/package/@favorodera/eslint-config"><img src="https://img.shields.io/npm/dt/@favorodera/eslint-config.svg?style=plastic&label=NPM%20Downloads&color=blue" alt="NPM Downloads"></a>
-    <a href="https://npmx.dev/package/@favorodera/eslint-config"><img src="https://img.shields.io/npm/v/@favorodera/eslint-config.svg?style=plastic&label=Version&color=blue" alt="NPM Version"></a>
-  </p>
-</div>
+<p align="center">
+  <picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/header/transparent.svg?title=%40favorodera%2Feslint-config&amp;subtitle=An+opinionated%2C+type-safe+ESLint+flat+configuration+for+JavaScript+and+TypeScript+projects.&amp;size=wide&amp;mode=dark" /><img alt="@favorodera/eslint-config" src="https://shieldcn.dev/header/transparent.svg?title=%40favorodera%2Feslint-config&amp;subtitle=An+opinionated%2C+type-safe+ESLint+flat+configuration+for+JavaScript+and+TypeScript+projects.&amp;size=wide&amp;mode=light" /></picture>
+</p>
 
-<br>
+<p align="center">
+  <a href="https://www.npmjs.com/package/@favorodera/eslint-config"><picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/npm/@favorodera/eslint-config.svg?variant=outline&amp;size=xs" /><img alt="npm version" src="https://shieldcn.dev/npm/@favorodera/eslint-config.svg?variant=outline&amp;size=xs&amp;mode=light" /></picture></a>
+  <a href="https://www.npmjs.com/package/@favorodera/eslint-config"><picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/npm/dm/@favorodera/eslint-config.svg?variant=outline&amp;size=xs" /><img alt="npm downloads" src="https://shieldcn.dev/npm/dm/@favorodera/eslint-config.svg?variant=outline&amp;size=xs&amp;mode=light" /></picture></a>
+  <a href="https://github.com/favorodera/eslint-config/actions"><picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/github/favorodera/eslint-config/ci.svg?variant=outline&amp;size=xs" /><img alt="CI status" src="https://shieldcn.dev/github/favorodera/eslint-config/ci.svg?variant=outline&amp;size=xs&amp;mode=light" /></picture></a>
+</p>
 
-An opinionated, highly customizable ESLint flat configuration factory. It provides a seamless, type-safe linting experience out-of-the-box for Vue, TypeScript, Tailwind CSS, Markdown, and more.
+`@favorodera/eslint-config` is an opinionated, type-safe ESLint flat configuration for JavaScript and TypeScript projects. It combines code-quality, sorting, and style rules with support for common project file formats and tooling.
 
 ## Features
 
-- **Flat Config First** — Built from the ground up for ESLint's new flat config system.
-- **TypeScript Support** — Robust linting for TypeScript out of the box.
-- **Vue Integration** — First-class support for Vue 3 single-file components.
-- **Stylistic Rules** — Consistent code styling powered by ESLint Stylistic.
-- **Tailwind CSS** — Built-in rules for Tailwind classes sorting and best practices.
-- **Auto-formatting** — Formats JSON, JSONC, Markdown, and JS/TS automatically.
-- **Type-safe Rules** — Rules are generated with JSDoc comments, giving you rich auto-complete and descriptions right in your IDE.
-- **Highly Configurable** — Easily enable or disable specific rulesets based on your project's needs.
-
-## Supported Configs
-
-The following configurations are bundled and enabled by default (they can be individually disabled or customized):
-
-- **JavaScript** — Core ESLint rules (`@eslint/js`)
-- **TypeScript** — Type-aware linting (`typescript-eslint`)
-- **Vue** — Single-file component support and accessibility linting (`eslint-plugin-vue`, `vue-eslint-parser`, `eslint-plugin-vuejs-accessibility`)
-- **Stylistic** — Formatting rules (`@stylistic/eslint-plugin`)
-- **CSS** — CSS linting and best practices (`@eslint/css` and `eslint-cssicorn`)
-- **Tailwind CSS** — Utility class linting and sorting (`eslint-plugin-better-tailwindcss`)
-- **Test** — Test and Vitest specific linting (`@vitest/eslint-plugin`)
-- **Imports** — Auto-sorting and import quality rules (`eslint-plugin-import-lite`)
-- **Unused Imports** — Unused imports and variables detection and cleanup (`eslint-plugin-unused-imports`)
-- **Markdown** — Linting for markdown files and embedded code blocks (`@eslint/markdown`)
-- **JSON/JSONC/JSON5** — Formatting and sorting for JSON files like `package.json` (`eslint-plugin-jsonc`)
-- **JSDoc** — Standardized comment formatting (`eslint-plugin-jsdoc`)
-- **Unicorn** — Various code quality improvements (`eslint-plugin-unicorn`)
-- **Perfectionist** — Sorting objects, imports, classes, etc. (`eslint-plugin-perfectionist`)
-- **Node** — Node.js specific linting rules (`eslint-plugin-n`)
+- Type-safe flat config with rule autocomplete.
+- Configurable rule groups with sensible defaults.
+- JavaScript, TypeScript, and Vue single-file component linting.
+- CSS and Tailwind CSS linting.
+- Markdown and embedded-code linting.
+- Import hygiene, sorting, and unused-import detection.
+- JSON-family, YAML, pnpm, Node.js, JSDoc, Unicorn, and Vitest rules.
 
+## Installation
 
-## Usage
-
-### Install
-
-<details>
-<summary><b>pnpm</b></summary>
+**Requirements:** Node.js 24 or later and ESLint 10.
 
-```bash
-pnpm install -D eslint @favorodera/eslint-config
+```sh
+pnpm add -D eslint@^10 @favorodera/eslint-config
 ```
-</details>
 
-<details>
-<summary><b>npm</b></summary>
-
-```bash
-npm install -D eslint @favorodera/eslint-config
-```
-</details>
-
-<details>
-<summary><b>yarn</b></summary>
+## Usage
 
-```bash
-yarn add -D eslint @favorodera/eslint-config
-```
-</details>
+Create `eslint.config.ts` in your project root:
 
-<details>
-<summary><b>bun</b></summary>
+```ts
+import { defineConfig } from '@favorodera/eslint-config'
 
-```bash
-bun add -D eslint @favorodera/eslint-config
+export default defineConfig()
 ```
-</details>
 
-### Configure
-
-Create an `eslint.config.ts` file in the root of your project. Since all configurations are enabled by default, you only need to pass options if you want to disable or customize something.
-
-The `factory()` function returns a `FlatConfigComposer` instance (powered by [`eslint-flat-config-utils`](https://github.com/antfu/eslint-flat-config-utils)), which acts as a powerful composer. This makes it incredibly easy to append your own configurations, override existing rules, or insert plugins seamlessly.
+All configuration groups are enabled by default. Disable groups you do not need or pass options to customize them:
 
 ```ts
-import { factory } from '@favorodera/eslint-config'
+import { defineConfig } from '@favorodera/eslint-config'
 
-export default factory({
-  // All configs are true by default!
-
-  // Example: Customize specific rulesets
+export default defineConfig({
+  ignores: (defaults) => {
+    return [...defaults, '**/generated/**']
+  },
   stylistic: {
-    indent: 4,
-    quotes: 'double',
+    settings: {
+      indent: 2,
+      quotes: 'single',
+      semi: false,
+    },
   },
-
-  // Example: Disable tailwind if you aren't using it
-  tailwind: false,
-})
-  // You can seamlessly chain methods to compose your config
-  .append({
-    // Add your own custom ESLint configs
-    ignores: ['src/types/rules.d.ts'],
-  })
-  .overrides({
-    // Easily override predefined rules by their name
-    'favorodera/typescript/rules': {
-      rules: {
-        'ts/no-explicit-any': 'off',
-      },
+  tailwind: {
+    settings: {
+      entryPoint: 'src/styles.css',
     },
-  })
-```
-
-## Development
-
-### Prerequisites
-
-- [Node.js](https://nodejs.org/) v22 or later
-- [pnpm](https://pnpm.io/installation) v11 or later
-
-### Getting Started
-
-```bash
-# Install all dependencies
-pnpm install
-
-# Start compiler in watch mode and open ESLint config inspector
-pnpm dev
-
-# Build the project
-pnpm build
-
-# Lint, typecheck, build, and test in one go
-pnpm ready
+  },
+  typescript: {
+    overrides: {
+      'typescript/no-explicit-any': 'off',
+    },
+  },
+  vue: false,
+})
 ```
 
-### Useful Commands
+Use `overrides` for rule changes and `settings` for configuration-specific settings where supported. Ignore arrays are appended to the built-in patterns; an ignore callback receives the defaults and returns the complete list.
+
+## Configuration groups
+
+| Option | Purpose |
+| --- | --- |
+| `javascript` | Core JavaScript rules. |
+| `typescript` | TypeScript linting. |
+| `vue` | Vue single-file components and accessibility rules. |
+| `stylistic` | Code style and formatting. |
+| `css` | CSS linting, including Tailwind CSS v4 syntax. |
+| `tailwind` | Tailwind class validation and consistency. |
+| `imports` | Import ordering and import quality. |
+| `unusedImports` | Unused imports and variables. |
+| `perfectionist` | Sorting rules for code structures. |
+| `jsdoc` | JSDoc validation and style. |
+| `jsonc` | JSON, JSON5, JSONC, `package.json`, and TypeScript config files. |
+| `yaml` | YAML linting and `pnpm-workspace.yaml` key ordering. |
+| `pnpm` | pnpm rules for `package.json` and `pnpm-workspace.yaml`. |
+| `node` | Node.js-specific rules. |
+| `unicorn` | Additional JavaScript and TypeScript code-quality rules. |
+| `vitest` | Rules for Vitest test files. |
+| `markdown` | Markdown linting; GitHub Flavored Markdown is enabled by default. |
+| `codeInMarkdown` | Rules for supported code blocks embedded in Markdown. |
+| `ignores` | Adds to or customizes the default ignored paths. Always applied. |
 
-| Command | What it does |
-|---------|-------------|
-| `pnpm dev` | Generates types, starts watch mode, and opens `@eslint/config-inspector` |
-| `pnpm build` | Production build using `tsdown` |
-| `pnpm script:generate-rules-types` | Extracts and generates type definitions for all ESLint rules |
-| `pnpm lint` | Lint the repository |
-| `pnpm typecheck` | Type-check without emitting files |
-| `pnpm test` | Run test suites with Vitest |
-| `pnpm ready` | Full pipeline: install → build → lint → typecheck → test |
-
-## Contributing & Issues
-
-Feel free to open an issue or submit a pull request if you'd like to improve the rules, add new features, or fix a bug. Please ensure you run `pnpm ready` before submitting your PR to make sure tests and linting pass.
-
-## Inspiration
+## Development
 
-This project takes heavy inspiration from [antfu/eslint-config](https://github.com/antfu/eslint-config) and similar modern ESLint presets, adapting their best patterns into a custom set of opinionated rules.
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for development and contribution guidelines.
 
 ## License
 
-[MIT](./LICENSE) &copy; [Favour Emeka](https://github.com/favorodera)
+[MIT](./LICENSE) © [Favour Emeka](https://github.com/favorodera)

package/dist/globs.d.mts

@@ -0,0 +1,40 @@
+/** Glob pattern for matching JavaScript files */
+export declare const jsGlob = "**/*.{js,cjs,mjs}";
+/** Glob pattern for matching TypeScript files */
+export declare const tsGlob = "**/*.{ts,cts,mts}";
+/** Glob pattern for matching Vue single-file components */
+export declare const vueGlob = "**/*.vue";
+/** Glob pattern for matching CSS files */
+export declare const cssGlob = "**/*.css";
+/** Glob pattern for matching Markdown files */
+export declare const mdGlob = "**/*.md";
+/** Glob pattern for matching virtual files extracted from Markdown */
+export declare const mdInMdGlob = "**/*.md/*.md";
+/** Glob pattern for matching code blocks embedded in Markdown files */
+export declare const codeInMdGlob = "**/*.md/**/*.{js,cjs,mjs,ts,cts,mts,vue,css}";
+/** Glob pattern for matching scripts files */
+export declare const scriptsGlob = "**/*.{js,cjs,mjs,ts,cts,mts}";
+/** Glob pattern for matching test files */
+export declare const testGlob = "**/*.{test,spec,bench,benchmark}.{js,cjs,mjs,ts,cts,mts}";
+/** Glob pattern for matching JSON files */
+export declare const jsonGlob = "**/*.json";
+/** Glob pattern for matching JSON5 files */
+export declare const json5Glob = "**/*.json5";
+/** Glob pattern for matching JSON with Comments files */
+export declare const jsoncGlob = "**/*.jsonc";
+/**
+ * Glob patterns matching standard and named TypeScript configuration files.
+ * Both `tsconfig.json` and files such as `tsconfig.build.json` are included.
+ */
+export declare const tsConfigGlob: string[];
+/** Glob pattern for matching YAML files */
+export declare const yamlGlob = "**/*.{yml,yaml}";
+/** Glob pattern for matching pnpm-workspace.yaml file */
+export declare const pnpmWorkspaceGlob = "pnpm-workspace.yaml";
+/** Glob pattern for matching package.json files */
+export declare const packageJsonGlob = "**/package.json";
+/**
+ * Common glob patterns for files and directories that should be ignored by ESLint.
+ * Includes node_modules, build outputs, lock files, temporary files, and tool-specific caches.
+ */
+export declare const ignoresGlob: string[];

package/dist/globs.mjs

@@ -0,0 +1 @@
+const e=`**/*.{js,cjs,mjs}`,t=`**/*.{ts,cts,mts}`,n=`**/*.vue`,r=`**/*.css`,i=`**/*.md`,a=`**/*.md/*.md`,o=`**/*.md/**/*.{js,cjs,mjs,ts,cts,mts,vue,css}`,s=`**/*.{js,cjs,mjs,ts,cts,mts}`,c=`**/*.{test,spec,bench,benchmark}.{js,cjs,mjs,ts,cts,mts}`,l=`**/*.json`,u=`**/*.json5`,d=`**/*.jsonc`,f=[`**/tsconfig.*.json`,`**/tsconfig.json`],p=`**/*.{yml,yaml}`,m=`pnpm-workspace.yaml`,h=`**/package.json`,g=/* @__PURE__ */ `**/node_modules/**,**/package-lock.json,**/pnpm-lock.yaml,**/*.min.*,**/.output,**/cache,**/dist/**,**/output,**/__snapshots__,**/coverage,**/.nuxt,**/.turbo,**/.vercel,**/.vite-inspect,**/.vitepress/cache,**/.data,**/.history,**/.idea,**/.temp,**/.tmp,**/temp,**/tmp,**/auto-import?(s).d.ts,**/components.d.ts,**/vite.config.*.timestamp-*,**/CHANGELOG*.md,**/LICENSE*,**/.*/skills,**/.agents,**/.claude,**/.context`.split(`,`);export{o as codeInMdGlob,r as cssGlob,g as ignoresGlob,e as jsGlob,u as json5Glob,l as jsonGlob,d as jsoncGlob,i as mdGlob,a as mdInMdGlob,h as packageJsonGlob,m as pnpmWorkspaceGlob,s as scriptsGlob,c as testGlob,f as tsConfigGlob,t as tsGlob,n as vueGlob,p as yamlGlob};