@whoj/eslint-config 7.5.1 → 9.2.0-beta.0

package/package.json

@@ -1,8 +1,7 @@
 {
   "name": "@whoj/eslint-config",
   "type": "module",
-  "version": "7.5.1",
-  "packageManager": "pnpm@10.30.3",
+  "version": "9.2.0-beta.0",
   "description": "ESLint config",
   "license": "MIT",
   "homepage": "https://github.com/who-jonson/eslint-config",
@@ -21,50 +20,32 @@
     "./cli": "./dist/cli.mjs",
     "./package.json": "./package.json"
   },
-  "main": "./dist/index.mjs",
-  "module": "./dist/index.mjs",
   "types": "./dist/index.d.mts",
-  "bin": "./bin/index.mjs",
   "files": [
     "bin",
-    "dist"
+    "dist",
+    "skills"
   ],
-  "scripts": {
-    "build": "nr typegen && tsdown --clean --dts",
-    "stub": "tsdown",
-    "dev": "npx @eslint/config-inspector --config eslint.config.ts",
-    "build:inspector": "pnpm build && npx @eslint/config-inspector build",
-    "watch": "tsdown --watch",
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix",
-    "typegen": "tsx scripts/typegen.ts && tsx scripts/versiongen.ts",
-    "prepack": "nr build",
-    "release": "bumpp && pnpm publish",
-    "test": "vitest",
-    "typecheck": "tsc --noEmit",
-    "prepare": "simple-git-hooks"
-  },
   "peerDependencies": {
-    "@angular-eslint/eslint-plugin": "catalog:peer",
-    "@angular-eslint/eslint-plugin-template": "catalog:peer",
-    "@angular-eslint/template-parser": "catalog:peer",
-    "@eslint-react/eslint-plugin": "catalog:peer",
-    "@next/eslint-plugin-next": "catalog:peer",
-    "@prettier/plugin-xml": "catalog:peer",
-    "@unocss/eslint-plugin": "catalog:peer",
-    "astro-eslint-parser": "catalog:peer",
-    "eslint": "catalog:peer",
-    "eslint-plugin-astro": "catalog:peer",
-    "eslint-plugin-format": "catalog:peer",
-    "eslint-plugin-jsx-a11y": "catalog:peer",
-    "eslint-plugin-react-hooks": "catalog:peer",
-    "eslint-plugin-react-refresh": "catalog:peer",
-    "eslint-plugin-solid": "catalog:peer",
-    "eslint-plugin-svelte": "catalog:peer",
-    "eslint-plugin-vuejs-accessibility": "catalog:peer",
-    "prettier-plugin-astro": "catalog:peer",
-    "prettier-plugin-slidev": "catalog:peer",
-    "svelte-eslint-parser": "catalog:peer"
+    "@angular-eslint/eslint-plugin": "^22.1.0",
+    "@angular-eslint/eslint-plugin-template": "^22.1.0",
+    "@angular-eslint/template-parser": "^22.1.0",
+    "@eslint-react/eslint-plugin": "^5.14.7",
+    "@next/eslint-plugin-next": "^16.2.10",
+    "@prettier/plugin-xml": "^3.4.2",
+    "@unocss/eslint-plugin": "^66.7.5",
+    "astro-eslint-parser": "^2.1 || ^3.0",
+    "eslint": "^9.0.0 || ^10.7.0",
+    "eslint-plugin-astro": "^2.1 || ^3.0",
+    "eslint-plugin-format": "^2.0.1",
+    "eslint-plugin-jsx-a11y": "^6.10.2",
+    "eslint-plugin-react-refresh": "^0.5.3",
+    "eslint-plugin-solid": "^0.14.5",
+    "eslint-plugin-svelte": "^3.20.0",
+    "eslint-plugin-vuejs-accessibility": "^2.5.0",
+    "prettier-plugin-astro": "^0.14.1",
+    "prettier-plugin-slidev": "^1.0.5",
+    "svelte-eslint-parser": "^1.8.0"
   },
   "peerDependenciesMeta": {
     "@angular-eslint/eslint-plugin": {
@@ -100,9 +81,6 @@
     "eslint-plugin-jsx-a11y": {
       "optional": true
     },
-    "eslint-plugin-react-hooks": {
-      "optional": true
-    },
     "eslint-plugin-react-refresh": {
       "optional": true
     },
@@ -126,89 +104,91 @@
     }
   },
   "dependencies": {
-    "@antfu/install-pkg": "catalog:prod",
-    "@clack/prompts": "catalog:prod",
-    "@eslint-community/eslint-plugin-eslint-comments": "catalog:prod",
-    "@eslint/markdown": "catalog:prod",
-    "@stylistic/eslint-plugin": "catalog:prod",
-    "@typescript-eslint/eslint-plugin": "catalog:prod",
-    "@typescript-eslint/parser": "catalog:prod",
-    "@vitest/eslint-plugin": "catalog:prod",
-    "@whoj/utils-core": "catalog:jetbrains",
-    "ansis": "catalog:prod",
-    "cac": "catalog:prod",
-    "eslint-config-flat-gitignore": "catalog:prod",
-    "eslint-flat-config-utils": "catalog:prod",
-    "eslint-merge-processors": "catalog:prod",
-    "eslint-plugin-antfu": "catalog:prod",
-    "eslint-plugin-command": "catalog:prod",
-    "eslint-plugin-import-lite": "catalog:prod",
-    "eslint-plugin-jsdoc": "catalog:prod",
-    "eslint-plugin-jsonc": "catalog:prod",
-    "eslint-plugin-n": "catalog:prod",
-    "eslint-plugin-no-only-tests": "catalog:prod",
-    "eslint-plugin-perfectionist": "catalog:prod",
-    "eslint-plugin-pnpm": "catalog:prod",
-    "eslint-plugin-regexp": "catalog:prod",
-    "eslint-plugin-toml": "catalog:prod",
-    "eslint-plugin-unicorn": "catalog:prod",
-    "eslint-plugin-unused-imports": "catalog:prod",
-    "eslint-plugin-vue": "catalog:prod",
-    "eslint-plugin-yml": "catalog:prod",
-    "eslint-processor-vue-blocks": "catalog:prod",
-    "fast-xml-parser": "catalog:jetbrains",
-    "globals": "catalog:prod",
-    "jsonc-eslint-parser": "catalog:prod",
-    "local-pkg": "catalog:prod",
-    "parse-gitignore": "catalog:prod",
-    "toml-eslint-parser": "catalog:prod",
-    "vue-eslint-parser": "catalog:prod",
-    "yaml-eslint-parser": "catalog:prod"
+    "@antfu/install-pkg": "^1.1.0",
+    "@clack/prompts": "^1.7.0",
+    "@e18e/eslint-plugin": "^0.5.1",
+    "@eslint-community/eslint-plugin-eslint-comments": "^4.7.2",
+    "@eslint/markdown": "^8.0.3",
+    "@stylistic/eslint-plugin": "^5.10.0",
+    "@typescript-eslint/eslint-plugin": "^8.63.0",
+    "@typescript-eslint/parser": "^8.63.0",
+    "@vitest/eslint-plugin": "^1.6.23",
+    "@whoj/utils-core": "^2.4.0",
+    "ansis": "^4.3.1",
+    "cac": "^7.0.0",
+    "eslint-config-flat-gitignore": "^2.3.0",
+    "eslint-flat-config-utils": "^3.2.0",
+    "eslint-merge-processors": "^2.0.0",
+    "eslint-plugin-antfu": "^3.2.3",
+    "eslint-plugin-command": "^3.5.2",
+    "eslint-plugin-import-lite": "^0.6.0",
+    "eslint-plugin-jsdoc": "^63.0.13",
+    "eslint-plugin-jsonc": "^3.3.0",
+    "eslint-plugin-n": "^18.2.2",
+    "eslint-plugin-no-only-tests": "^3.4.0",
+    "eslint-plugin-perfectionist": "^5.10.0",
+    "eslint-plugin-pnpm": "^1.6.1",
+    "eslint-plugin-regexp": "^3.1.1",
+    "eslint-plugin-toml": "^1.4.0",
+    "eslint-plugin-unicorn": "^71.1.0",
+    "eslint-plugin-unused-imports": "^4.4.1",
+    "eslint-plugin-vue": "^10.9.2",
+    "eslint-plugin-yml": "^3.6.0",
+    "eslint-processor-vue-blocks": "^2.0.0",
+    "fast-xml-parser": "^5.10.0",
+    "globals": "^17.7.0",
+    "local-pkg": "^1.2.1",
+    "parse-gitignore": "^2.0.0",
+    "toml-eslint-parser": "^1.0.3",
+    "vue-eslint-parser": "^10.4.1",
+    "yaml-eslint-parser": "^2.1.0"
   },
   "devDependencies": {
-    "@angular-eslint/eslint-plugin": "catalog:peer",
-    "@angular-eslint/eslint-plugin-template": "catalog:peer",
-    "@angular-eslint/template-parser": "catalog:peer",
-    "@angular/core": "catalog:dev",
-    "@antfu/ni": "catalog:dev",
-    "@eslint-react/eslint-plugin": "catalog:peer",
-    "@eslint/config-inspector": "catalog:dev",
-    "@next/eslint-plugin-next": "catalog:peer",
-    "@prettier/plugin-xml": "catalog:peer",
-    "@types/eslint-plugin-jsx-a11y": "catalog:dev",
-    "@types/node": "catalog:dev",
-    "@unocss/eslint-plugin": "catalog:peer",
-    "@whoj/eslint-config": "workspace:*",
-    "astro-eslint-parser": "catalog:peer",
-    "baseline-browser-mapping": "catalog:dev",
-    "bumpp": "catalog:dev",
-    "eslint": "catalog:peer",
-    "eslint-plugin-astro": "catalog:peer",
-    "eslint-plugin-erasable-syntax-only": "catalog:peer",
-    "eslint-plugin-format": "catalog:peer",
-    "eslint-plugin-jsx-a11y": "catalog:peer",
-    "eslint-plugin-react-hooks": "catalog:peer",
-    "eslint-plugin-react-refresh": "catalog:peer",
-    "eslint-plugin-solid": "catalog:peer",
-    "eslint-plugin-svelte": "catalog:peer",
-    "eslint-plugin-vuejs-accessibility": "catalog:peer",
-    "eslint-typegen": "catalog:dev",
-    "execa": "catalog:dev",
-    "find-up-simple": "catalog:inline",
-    "jiti": "catalog:dev",
-    "lint-staged": "catalog:dev",
-    "pnpm-workspace-yaml": "catalog:dev",
-    "prettier-plugin-astro": "catalog:peer",
-    "prettier-plugin-slidev": "catalog:peer",
-    "simple-git-hooks": "catalog:dev",
-    "svelte": "catalog:peer",
-    "svelte-eslint-parser": "catalog:peer",
-    "tinyglobby": "catalog:dev",
-    "tsdown": "catalog:dev",
-    "tsx": "catalog:dev",
-    "typescript": "catalog:dev",
-    "vitest": "catalog:dev",
-    "vue": "catalog:peer"
+    "@angular-eslint/eslint-plugin": "^22.1.0",
+    "@angular-eslint/eslint-plugin-template": "^22.1.0",
+    "@angular-eslint/template-parser": "^22.1.0",
+    "@angular/core": "^22.0.6",
+    "@antfu/ni": "^30.2.0",
+    "@eslint-react/eslint-plugin": "^5.14.7",
+    "@eslint/config-inspector": "^3.0.4",
+    "@next/eslint-plugin-next": "^16.2.10",
+    "@prettier/plugin-xml": "^3.4.2",
+    "@types/eslint-plugin-jsx-a11y": "^6.10.1",
+    "@types/node": "^26.1.1",
+    "@unocss/eslint-plugin": "^66.7.5",
+    "astro-eslint-parser": "^2.1 || ^3.0",
+    "baseline-browser-mapping": "^2.10.43",
+    "bumpp": "^11.1.0",
+    "eslint": "^9.0.0 || ^10.7.0",
+    "eslint-plugin-astro": "^2.1 || ^3.0",
+    "eslint-plugin-erasable-syntax-only": "^0.4.2",
+    "eslint-plugin-format": "^2.0.1",
+    "eslint-plugin-jsx-a11y": "^6.10.2",
+    "eslint-plugin-react-refresh": "^0.5.3",
+    "eslint-plugin-solid": "^0.14.5",
+    "eslint-plugin-svelte": "^3.20.0",
+    "eslint-plugin-vuejs-accessibility": "^2.5.0",
+    "eslint-typegen": "^2.3.1",
+    "execa": "^9.6.1",
+    "find-up-simple": "^1.0.1",
+    "jiti": "^2.7.0",
+    "lint-staged": "^17.0.8",
+    "pnpm-workspace-yaml": "^1.6.1",
+    "prettier-plugin-astro": "^0.14.1",
+    "prettier-plugin-slidev": "^1.0.5",
+    "simple-git-hooks": "^2.13.1",
+    "skills-npm": "^1.2.0",
+    "svelte": "^5.56.4",
+    "svelte-eslint-parser": "^1.8.0",
+    "tinyglobby": "^0.2.17",
+    "tsdown": "^0.22.7",
+    "tsdown-stale-guard": "^0.1.3",
+    "tsnapi": "^1.0.0",
+    "tsx": "^4.23.1",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.10",
+    "vue": "^3.5.39",
+    "@whoj/eslint-config": "9.2.0-beta.0"
   },
   "resolutions": {
     "@eslint-community/eslint-utils": "catalog:peer",
@@ -216,6 +196,7 @@
     "@typescript-eslint/utils": "catalog:peer",
     "chokidar": "catalog:dev",
     "eslint": "catalog:peer",
+    "js-yaml": "catalog:prod",
     "semver": "catalog:dev",
     "synckit": "catalog:dev",
     "tsx": "catalog:dev"
@@ -225,5 +206,35 @@
   },
   "lint-staged": {
     "*": "eslint --fix"
+  },
+  "inlinedDependencies": {
+    "@eslint-community/eslint-utils": "4.9.1",
+    "@typescript-eslint/scope-manager": "8.62.0",
+    "@typescript-eslint/types": "8.62.0",
+    "@typescript-eslint/utils": "8.62.0",
+    "@typescript-eslint/visitor-keys": "8.62.0",
+    "cached-factory": "0.3.0",
+    "eslint-plugin-erasable-syntax-only": "0.4.2",
+    "eslint-visitor-keys": [
+      "3.4.3",
+      "5.0.1"
+    ],
+    "find-up-simple": "1.0.1"
+  },
+  "scripts": {
+    "build": "nr typegen && tsdown --clean --dts",
+    "stub": "tsdown",
+    "dev": "npx @eslint/config-inspector --config eslint.config.ts",
+    "build:inspector": "pnpm build && npx @eslint/config-inspector build --config eslint.config.ts --out-dir ./.eslint-config-inspector",
+    "watch": "tsdown --watch",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "typegen": "tsx scripts/typegen.ts && tsx scripts/versiongen.ts",
+    "release": "bumpp && pnpm publish",
+    "test": "vitest",
+    "typecheck": "tsc --noEmit"
+  },
+  "bin": {
+    "eslint-config": "./bin/index.mjs"
   }
-}
+}

package/skills/whoj-eslint-config/SKILL.md

@@ -0,0 +1,152 @@
+---
+name: whoj-eslint-config
+description: Configure ESLint flat config, customize rules, or fix lint errors in a repo that depends on @whoj/eslint-config; also covers scaffolding eslint.config with its CLI wizard.
+---
+
+# @whoj/eslint-config
+
+This skill applies when working in a repository that has `@whoj/eslint-config` listed as a
+dependency (usually a `devDependency`) in `package.json`. It covers three things: configuring the
+`whoj()` factory, fixing lint errors this config produces, and running the setup/migration CLI.
+
+## 1. Configuring the `whoj()` factory
+
+The package default-exports a factory function. The minimal setup is:
+
+```js
+// eslint.config.mjs
+import whoj from '@whoj/eslint-config';
+
+export default whoj();
+```
+
+Key shape rules — verified against the package's own `src/factory.ts` and `src/types.ts`:
+
+- **Boolean-or-options-object pattern**: most integration keys on the first argument (e.g. `vue`,
+  `react`, `typescript`, `stylistic`, `formatters`, and others) accept either
+  `true`/`false` or a config object for that integration. Passing `true` uses that integration's
+  defaults; passing an object lets you set sub-options (including that integration's own
+  `overrides`).
+- Several integrations auto-detect and enable themselves based on installed dependencies or repo
+  files (e.g. `typescript` turns on if `typescript` is installed, `vue` if `vue`/`nuxt`/`vitepress`/
+  `@slidev/cli` is installed, `pnpm` if a `pnpm-workspace.yaml` is found). You only need to pass the
+  key explicitly to override the default/auto-detected value.
+- **`overrides` pattern**: nearly every sub-config accepts an `overrides` field
+  (`OptionsOverrides`) — a plain ESLint `rules` object merged in last, so it always wins over the
+  config's own defaults. Prefer setting `overrides` on the specific integration rather than a
+  top-level blanket rule change. There is also a **deprecated** top-level `overrides` map on
+  `OptionsConfig`, covering the same integration keys, for the same purpose — prefer the
+  per-integration `overrides` field on new code.
+- The factory returns a `FlatConfigComposer`, which supports chaining, e.g.
+  `whoj({ ... }).overrides({ 'whoj/some-name': { rules: { ... } } })` to target a specific named
+  config block by its `name` field, or `.append(...)` for extra flat config objects. `whoj()` also
+  accepts any number of extra plain flat-config-object arguments after the first, which are
+  appended as-is (no merging into `overrides`).
+- The first argument must NOT contain a `files` property (the factory throws if it does) — pass
+  file-scoped rules as additional flat config arguments instead.
+
+**Do not hardcode an exhaustive list of every option field here — it will go stale across
+versions.** Before configuring anything non-trivial, read the actual shipped types and/or docs for
+the installed version:
+
+- `node_modules/@whoj/eslint-config/dist/index.d.mts` — authoritative, version-accurate type
+  definitions for `OptionsConfig` and every sub-options interface.
+- The package's `README.md` (`Customization` section) if available, for narrative examples.
+
+## 2. Fixing lint errors produced by this config
+
+This config renames plugin prefixes in reported rule IDs via `composer.renamePlugins(...)` (see
+`defaultPluginRenaming` in the package's `src/factory.ts`), so error output will show the renamed
+prefix, not the upstream plugin's own prefix. The verified rename table is:
+
+| Reported prefix | Underlying plugin               |
+| --------------- | ------------------------------- |
+| `node/*`        | `n` (eslint-plugin-n)           |
+| `yaml/*`        | `yml` (eslint-plugin-yml)       |
+| `test/*`        | `vitest` (eslint-plugin-vitest) |
+| `next/*`        | `@next/next`                    |
+| `style/*`       | `@stylistic`                    |
+| `import/*`      | `import-lite`                   |
+| `react/*`       | `@eslint-react`                 |
+| `ts/*`          | `@typescript-eslint`            |
+
+This table reflects `defaultPluginRenaming` in the installed version — if a prefix doesn't match,
+check `node_modules/@whoj/eslint-config/dist/index.mjs` (or `dist/index.d.mts`) for the current
+exported `defaultPluginRenaming`.
+
+When you see a rule ID like `ts/no-unused-vars`, `style/quotes`, or `node/no-process-exit` in lint
+output, that maps to the upstream plugin on the right — use that to find the rule's documentation
+(the renamed prefix will not resolve on the plugin's own docs site).
+
+Rules with no rename listed above (e.g. plain `unicorn/*`, `vue/*`, `jsdoc/*`, `perfectionist/*`,
+`regexp/*`) are reported under their original plugin prefix.
+
+**To suppress or adjust a specific rule that doesn't fit the codebase**: prefer adding it to the
+`overrides` object of the relevant sub-config in `eslint.config.mjs`, not a blanket
+`// eslint-disable` comment or file-wide disable. Example — silencing a TypeScript rule and a
+stylistic rule:
+
+```js
+// eslint.config.mjs
+import whoj from '@whoj/eslint-config';
+
+export default whoj({
+  stylistic: {
+    overrides: {
+      'style/quotes': ['error', 'double'],
+    },
+  },
+  typescript: {
+    overrides: {
+      'ts/no-unused-vars': 'off',
+    },
+  },
+});
+```
+
+Only fall back to inline `// eslint-disable-next-line <rule>` for a genuinely one-off exception in
+a single location; use the `overrides` mechanism when the rule should not apply project-wide or
+for a whole integration's file set.
+
+## 3. CLI setup / migration wizard
+
+The package ships a CLI (`bin/index.mjs`, wired to `src/cli/index.ts` → `src/cli/run.ts`) invoked
+via:
+
+```bash
+pnpm dlx @whoj/eslint-config@latest
+# or
+npx @whoj/eslint-config@latest
+# or
+bunx @whoj/eslint-config@latest
+```
+
+Verified behavior of the wizard (reading `src/cli/run.ts`, `src/cli/constants.ts`, and
+`src/cli/stages/*.ts`) — this reflects the installed version; run the CLI with `--help` to confirm
+current flags/behavior if something doesn't match:
+
+- It refuses to run if `eslint.config.js` already exists in the current directory (exits with an
+  error) — it is an initial-setup/migration tool, not an incremental re-configurator.
+- If the repo has uncommitted git changes, it prompts for confirmation before continuing (skip
+  this and all prompts with `--yes`/`-y`, or `SKIP_PROMPT=1` env var).
+- It prompts (multiselect) for optional framework templates to enable: `vue`, `react`, `solid`,
+  `svelte`, `slidev`, `astro` — pass one or more non-interactively with `--template <name>`
+  (repeatable), e.g. `--template vue --template react`.
+- It prompts (multiselect) for optional extras: `unocss` and `formatter` (external
+  Prettier/dprint formatting support) — pass non-interactively with `--extra <name>` (repeatable).
+- It generates `eslint.config.js` (if the consumer's `package.json` has `"type": "module"`) or
+  `eslint.config.mjs` (otherwise), setting the corresponding `true` flags (e.g. `vue: true`,
+  `formatters: true`, `unocss: true`) in the generated `whoj({...})` call based on your selections.
+- If a legacy `.eslintignore` file exists, it parses it and merges its patterns into the generated
+  config's top-level `ignores` array (negated `!pattern` entries are preserved for un-ignoring).
+- It offers (confirm prompts, default yes) to also update `.idea/jsLinters/` config for
+  JetBrains IDEs (WebStorm/PhpStorm) and `.vscode/settings.json` for VS Code, wiring ESLint as the
+  formatter and silencing stylistic rules in-editor while keeping them auto-fixable on save.
+- It does not delete legacy ESLint/Prettier config files automatically — it lists any it finds
+  (files matching `/eslint|prettier/` but not the new `eslint.config.*`) and tells you that you can
+  remove them manually.
+- After running, it does not install dependencies or run ESLint itself — it prints a reminder to
+  run `pnpm install` and `eslint --fix` next.
+
+Use `--yes` for non-interactive/CI scaffolding when the defaults (no frameworks, no extras,
+JetBrains config on) are acceptable; otherwise omit flags and let the wizard prompt.