@isentinel/eslint-config 5.2.0 → 6.0.0-beta.10

package/README.md

@@ -347,6 +347,102 @@ the new prefix:
 type foo = { bar: 2 }
 ```
 
+### Rules Overrides
+
+Certain rules would only be enabled in specific files, for example, `ts/*` rules
+would only be enabled in `.ts` files and `vue/*` rules would only be enabled in
+`.vue` files. If you want to override the rules, you need to specify the file
+extension:
+
+```js
+// eslint.config.js
+import antfu from "@antfu/eslint-config";
+
+export default antfu(
+	{
+		typescript: true,
+		vue: true,
+	},
+	{
+		// Remember to specify the file glob here, otherwise it might cause the
+		// vue plugin to handle non-vue files
+		files: ["**/*.vue"],
+		rules: {
+			"vue/operator-linebreak": ["error", "before"],
+		},
+	},
+	{
+		// Without `files`, they are general rules for all files (Markdown
+		// excluded — see note below)
+		rules: {
+			"style/semi": ["error", "never"],
+		},
+	},
+);
+```
+
+<!-- prettier-ignore -->
+> [!NOTE]
+> Rule overrides without an explicit `files` constraint are> automatically
+> excluded from Markdown files, via
+> [`composer.setDefaultIgnores`](https://github.com/antfu/eslint-flat-config-utils#composersetdefaultignores).
+> This prevents JS-only rules (e.g. `no-irregular-whitespace`,
+> `perfectionist/sort-imports`) from crashing on `@eslint/markdown`'s
+> `SourceCode`, which doesn't expose JS-specific methods like
+> `getAllComments()`. If you want a rule to apply to Markdown, scope it
+> explicitly with `files: ['**/*.md']`.
+
+We also provided the `overrides` options in each integration to make it easier:
+
+```js
+// eslint.config.ts
+import isentinel from "@isentinel/eslint-config";
+
+export default isentinel({
+	typescript: {
+		overrides: {
+			"ts/consistent-type-definitions": ["error", "interface"],
+		},
+	},
+	yaml: {
+		overrides: {
+			// ...
+		},
+	},
+});
+```
+
+#### Redundant Override Detection
+
+Overrides that re-state what the preset already resolves to by default fail to
+typecheck, so you learn immediately (in-editor, no lint run needed) when a
+preset update makes one of your overrides redundant:
+
+```ts
+export default isentinel({
+	rules: {
+		// Type error: 'no-alert' already defaults to this value in the preset;
+		// remove the override, or set `redundancyCheck: false` to disable this
+		// check
+		"no-alert": "error",
+	},
+});
+```
+
+The check understands severity aliases (`2` ≙ `"error"`), option tuples (flagged
+only on an exact match), flat-config merge semantics (a bare severity keeps the
+previous options, so it is redundant whenever the severity matches), and the
+`type`/`roblox` variants — a rule that only defaults to `"error"` for
+`type: "package"` is not flagged in a game config. It applies to the top-level
+`rules`, every per-integration `overrides`, and un-scoped extra configs; both
+the ESLint and oxlint factories are covered.
+
+Compared defaults are the canonical (CI, non-editor) ones: editor/agent
+downgrades, `defaultSeverity` promotion and oxlint hybrid rule-dropping are
+intentionally ignored. `files`-scoped configs and composer `.override()` calls
+are not checked. Opt out entirely with `redundancyCheck: false`, or per line
+with `// @ts-expect-error`.
+
 ### Spell Checker
 
 This config includes the [CSpell](https://cspell.org/) plugin by default, which
@@ -427,9 +523,52 @@ Running `npx eslint` should prompt you to install the required dependencies,
 otherwise, you can install them manually:
 
 ```bash
-pnpm i -D eslint-plugin-react-x eslint-plugin-react-hooks eslint-plugin-react-naming-convention eslint-plugin-jest
+pnpm i -D eslint-plugin-react-x eslint-plugin-react-jsx eslint-plugin-react-naming-convention eslint-plugin-jest
+```
+
+#### Oxlint
+
+The config can run alongside (or be replaced by)
+[oxlint](https://oxc.rs/docs/guide/usage/linter/) in three modes: ESLint-only
+(the default), hybrid (`oxlint && eslint`), and oxlint standalone via the
+`@isentinel/eslint-config/oxlint` export.
+
+```ts
+// eslint.config.ts - hybrid mode: ESLint drops every rule oxlint covers
+import isentinel from "@isentinel/eslint-config";
+
+export default isentinel({
+	oxlint: true,
+});
+```
+
+```ts
+// oxlint.config.ts
+import { isentinel } from "@isentinel/eslint-config/oxlint";
+
+export default isentinel({
+	name: "project/options",
+});
+```
+
+Requires the optional peer dependencies:
+
+```bash
+pnpm i -D oxlint oxlint-tsgolint
 ```
 
+See [docs/oxlint.md](./docs/oxlint.md) for the per-rule mapping, what stays in
+ESLint and why, and migration notes.
+
+#### Type-Aware Split
+
+On large projects the type-aware rules dominate ESLint wall time; an explicit
+numeric `--concurrency` is the biggest single win. The `typeAware` option
+additionally splits the config into two complementary passes: a non-type-aware
+pass (`typeAware: false`) that never builds a TypeScript program and a
+type-aware-only pass (`typeAware: "only"`). Together they cover exactly the full
+config. See [docs/type-aware-split.md](./docs/type-aware-split.md).
+
 #### ESLint Plugin Development
 
 If you're developing an ESLint plugin, you can enable specialized rules to help
@@ -451,26 +590,33 @@ otherwise, you can install them manually:
 pnpm i -D eslint-plugin-eslint-plugin
 ```
 
-### Lint Staged
+### Git hooks
 
-If you want to apply lint and auto-fix before every commit, you can add the
-following to your `package.json`:
+If you want to apply lint and auto-fix before every commit, use
+[hk](https://hk.jdx.dev). Create `hk.pkl` in your project root:
 
-```json
-{
-	"simple-git-hooks": {
-		"pre-commit": "pnpm lint-staged"
-	},
-	"lint-staged": {
-		"*": "eslint --fix"
+```pkl
+amends "package://github.com/jdx/hk/releases/download/v1.48.0/hk@1.48.0#/Config.pkl"
+
+hooks {
+	["pre-commit"] {
+		fix = true
+		steps {
+			["eslint"] {
+				glob = List("*")
+				check = "eslint --no-warn-ignored {{files}}"
+				fix = "eslint --fix --no-warn-ignored {{files}}"
+			}
+		}
 	}
 }
 ```
 
-and then
+and then install hk and activate the hooks:
 
 ```bash
-pnpm i -D lint-staged simple-git-hooks
+mise use hk pkl # or see https://hk.jdx.dev for other install methods
+hk install
 ```
 
 ## View what rules are enabled

package/dist/cli.d.mts

@@ -1 +1 @@
-export { };
+export {}

package/dist/cli.mjs

@@ -1 +1 @@
-export {  };
+export {};