feat: new rule overrides, plugin syncs, and TS 5.8 support

Author: kirklin

.github/workflows/ci.yml

@@ -24,7 +24,7 @@ jobs:
           node-version: lts/*
 
       - name: Setup
-        run: npm i -g @kirklin/ni
+        run: npm i -g @antfu/ni
 
       - name: Install
         run: nci
@@ -59,7 +59,7 @@ jobs:
           node-version: ${{ matrix.node }}
 
       - name: Setup
-        run: npm i -g @kirklin/ni
+        run: npm i -g @antfu/ni
 
       - name: Install
         run: nci

README.md

@@ -33,7 +33,7 @@
 - Optional [formatters](#formatters) support for formatting CSS, HTML, XML, etc.
 - **Style principle**: Minimal for reading, stable for diff, consistent
   - Sorted imports, dangling commas
-  - Single quotes, no semi
+  - double quotes, no semi
   - Using [ESLint Stylistic](https://github.com/eslint-stylistic/eslint-stylistic)
 - Respects `.gitignore` by default
 - Requires ESLint v9.5.0+
@@ -112,8 +112,8 @@ For example:
 ```json
 {
   "scripts": {
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix"
+    "lint": "eslint",
+    "lint:fix": "eslint --fix"
   }
 }
 ```
@@ -555,6 +555,27 @@ export default kirklin({
 
 As it's in maintenance mode, we only accept bug fixes for Vue 2. It might also be removed in the future when `eslint-plugin-vue` drops support for Vue 2. We recommend upgrading to Vue 3 if possible.
 
+#### Vue Accessibility
+
+To enable Vue accessibility support, you need to explicitly turn it on:
+
+```js
+// eslint.config.js
+import kirklin from "@kirklin/eslint-config";
+
+export default kirklin({
+  vue: {
+    a11y: true
+  },
+});
+```
+
+Running `npx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:
+
+```bash
+npm i -D eslint-plugin-vuejs-accessibility
+```
+
 ### Optional Configs
 
 We provide some optional configs for specific use cases, that we don't include their dependencies by default.

README.zh-cn.md

@@ -40,10 +40,10 @@
 - 可选的[格式化程序](#formatters)支持CSS，HTML，XML等。
 - **样式原则**：最小化阅读，稳定的差异性，保持一致性
 
-> [!NOTE]  
-> 自 v1.0.0 版本起，该配置已重写为新的 [ESLint Flat 配置](https://eslint.org/docs/latest/use/configure/configuration-files-new)，详细信息请查看 [发布说明](https://github.com/kirklin/eslint-config/releases/tag/v1.0.0)。  
->  
-> 自 v2.7.0 版本起，现要求使用 ESLint v9.5.0 及以上版本。  
+> [!NOTE]
+> 自 v1.0.0 版本起，该配置已重写为新的 [ESLint Flat 配置](https://eslint.org/docs/latest/use/configure/configuration-files-new)，详细信息请查看 [发布说明](https://github.com/kirklin/eslint-config/releases/tag/v1.0.0)。
+>
+> 自 v2.7.0 版本起，现要求使用 ESLint v9.5.0 及以上版本。
 
 ## 使用方法
 
@@ -747,17 +747,17 @@ export default kirklin({
 });
 ```
 
-### 编辑器特定的禁用规则  
+### 编辑器特定的禁用规则
 
-当 ESLint 在代码编辑器中运行时，以下规则的自动修复功能被禁用：  
+当 ESLint 在代码编辑器中运行时，以下规则的自动修复功能被禁用：
 
-- [`prefer-const`](https://eslint.org/docs/rules/prefer-const)  
-- [`test/no-only-tests`](https://github.com/levibuzolic/eslint-plugin-no-only-tests)  
-- [`unused-imports/no-unused-imports`](https://www.npmjs.com/package/eslint-plugin-unused-imports)  
+- [`prefer-const`](https://eslint.org/docs/rules/prefer-const)
+- [`test/no-only-tests`](https://github.com/levibuzolic/eslint-plugin-no-only-tests)
+- [`unused-imports/no-unused-imports`](https://www.npmjs.com/package/eslint-plugin-unused-imports)
 
-自 v3.0.0 版本起，这些规则不再被完全禁用，而是通过 [此辅助工具](https://github.com/antfu/eslint-flat-config-utils#composerdisablerulesfix) 设为不可自动修复。  
+自 v3.0.0 版本起，这些规则不再被完全禁用，而是通过 [此辅助工具](https://github.com/antfu/eslint-flat-config-utils#composerdisablerulesfix) 设为不可自动修复。
 
-这样可以防止编辑器在重构代码时自动删除未使用的导入，以提供更好的开发体验。这些规则仍然会在你通过终端运行 ESLint 或使用 [Lint Staged](#lint-staged) 时生效。  
+这样可以防止编辑器在重构代码时自动删除未使用的导入，以提供更好的开发体验。这些规则仍然会在你通过终端运行 ESLint 或使用 [Lint Staged](#lint-staged) 时生效。
 
 如果你不希望有这种行为，你可以手动禁用它们。
 

eslint.config.ts

@@ -5,19 +5,23 @@ import { kirklin } from "./src";
 
 export default kirklin(
   {
-    vue: true,
+    vue: {
+      a11y: true,
+    },
     react: true,
     solid: true,
     svelte: true,
     astro: true,
     typescript: true,
     formatters: true,
+    pnpm: true,
     type: "lib",
   },
   {
     ignores: [
       "fixtures",
       "_fixtures",
+      "**/constants-generated.ts",
     ],
   },
   {

fixtures/input/typescript.ts

@@ -78,3 +78,13 @@ var fn = (): string => {
 
 log(car1, car2, favoriteFruit, numericValue, fn())
 
+// Generator
+export function* generator1() {
+  let id = 0;
+  while (id < 100) {
+    yield id++;
+  }
+}
+export function * generator2() {
+  yield* generator1()
+}

fixtures/output/all/typescript.ts

@@ -82,3 +82,14 @@ function fn(): string {
 }
 
 log(car1, car2, favoriteFruit, numericValue, fn())
+
+// Generator
+export function* generator1() {
+  let id = 0
+  while (id < 100) {
+    yield id++
+  }
+}
+export function* generator2() {
+  yield* generator1()
+}

fixtures/output/no-markdown-with-formatters/typescript.ts

@@ -82,3 +82,14 @@ function fn(): string {
 }
 
 log(car1, car2, favoriteFruit, numericValue, fn())
+
+// Generator
+export function* generator1() {
+  let id = 0
+  while (id < 100) {
+    yield id++
+  }
+}
+export function* generator2() {
+  yield* generator1()
+}

fixtures/output/no-style/typescript.ts

@@ -78,3 +78,13 @@ const fn = (): string => {
 
 log(car1, car2, favoriteFruit, numericValue, fn())
 
+// Generator
+export function* generator1() {
+  let id = 0;
+  while (id < 100) {
+    yield id++;
+  }
+}
+export function * generator2() {
+  yield* generator1()
+}

fixtures/output/tab-double-quotes/typescript.ts

@@ -82,3 +82,14 @@ function fn(): string {
 }
 
 log(car1, car2, favoriteFruit, numericValue, fn())
+
+// Generator
+export function* generator1() {
+	let id = 0
+	while (id < 100) {
+		yield id++
+	}
+}
+export function* generator2() {
+	yield* generator1()
+}

fixtures/output/ts-override/typescript.ts

@@ -82,3 +82,14 @@ function fn(): string {
 }
 
 log(car1, car2, favoriteFruit, numericValue, fn())
+
+// Generator
+export function* generator1() {
+  let id = 0
+  while (id < 100) {
+    yield id++
+  }
+}
+export function* generator2() {
+  yield* generator1()
+}

fixtures/output/ts-strict-with-react/typescript.ts

@@ -82,3 +82,14 @@ function fn(): string {
 }
 
 log(car1, car2, favoriteFruit, numericValue, fn())
+
+// Generator
+export function* generator1() {
+  let id = 0
+  while (id < 100) {
+    yield id++
+  }
+}
+export function* generator2() {
+  yield* generator1()
+}

fixtures/output/ts-strict/typescript.ts

@@ -82,3 +82,14 @@ function fn(): string {
 }
 
 log(car1, car2, favoriteFruit, numericValue, fn())
+
+// Generator
+export function* generator1() {
+  let id = 0
+  while (id < 100) {
+    yield id++
+  }
+}
+export function* generator2() {
+  yield* generator1()
+}

fixtures/output/with-formatters/typescript.ts

@@ -82,3 +82,14 @@ function fn(): string {
 }
 
 log(car1, car2, favoriteFruit, numericValue, fn())
+
+// Generator
+export function* generator1() {
+  let id = 0
+  while (id < 100) {
+    yield id++
+  }
+}
+export function* generator2() {
+  yield* generator1()
+}