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

package/README.md

@@ -347,6 +347,71 @@ 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: {
+			// ...
+		},
+	},
+});
+```
+
 ### Spell Checker
 
 This config includes the [CSpell](https://cspell.org/) plugin by default, which
@@ -427,7 +492,7 @@ 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
 ```
 
 #### ESLint Plugin Development
@@ -451,26 +516,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.mjs

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