@huangjunsen/eslint-config 1.0.3 → 1.0.5

package/__tests__/validate-flat-configs.test.js

@@ -0,0 +1,86 @@
+/**
+ * 验证 Flat Config 预设
+ *
+ * 重点覆盖 Vue3 + TypeScript 场景：
+ * - 泛型箭头函数（<T,>）能被正常解析
+ * - 不会退回 espree 解析器
+ * - 噪音型风格规则保持关闭
+ */
+
+const assert = require('assert');
+const path = require('path');
+const fs = require('fs-extra');
+const { FlatESLint } = require('eslint/use-at-your-own-risk');
+
+const cwd = path.resolve(__dirname, '..');
+const fixtures = path.resolve(__dirname, './fixtures');
+const tmpDir = path.resolve(__dirname, './.tmp-flat');
+
+const VUE_FIXTURE = path.join(tmpDir, 'Generic.vue');
+const TS_FIXTURE = path.join(tmpDir, 'generic.ts');
+
+const VUE_SOURCE = `<template>
+  <div>{{ label }}</div>
+</template>
+
+<script lang="ts" setup>
+const buildList = <T,>(list: T[] | undefined, getter: (item: T) => string) => {
+  return (list || []).map((item) => ({ name: getter(item) }));
+};
+
+const label = buildList([1, 2], (item) => String(item)).length;
+</script>
+`;
+
+const TS_SOURCE = `export const toName = <T,>(item: T, getter: (value: T) => string): string => {
+  return getter(item);
+};
+`;
+
+describe('Validate Flat configs', () => {
+  before(() => {
+    fs.outputFileSync(VUE_FIXTURE, VUE_SOURCE, 'utf8');
+    fs.outputFileSync(TS_FIXTURE, TS_SOURCE, 'utf8');
+  });
+
+  after(() => {
+    fs.removeSync(tmpDir);
+  });
+
+  it('flat/vue 能解析 TS 泛型与 Vue SFC', async () => {
+    const overrideConfig = [...require('../flat/vue.js'), ...require('../flat/typescript.js')];
+    const cli = new FlatESLint({ cwd, overrideConfigFile: true, overrideConfig });
+
+    const results = await cli.lintFiles([VUE_FIXTURE, TS_FIXTURE]);
+    assert.strictEqual(results.length, 2);
+
+    for (const result of results) {
+      const fatal = result.messages.filter((message) => message.fatal);
+      assert.strictEqual(
+        fatal.length,
+        0,
+        `${path.basename(result.filePath)} 出现解析错误：${fatal.map((m) => m.message).join('; ')}`,
+      );
+    }
+  });
+
+  it('flat/vue 关闭了无法自动修复的格式类规则', () => {
+    const configs = require('../flat/vue.js');
+    const rules = Object.assign({}, ...configs.filter((config) => config.rules).map((c) => c.rules));
+
+    // 这些规则属于 eslint-plugin-vue 的 strongly-recommended / recommended 档位，
+    // 会产生大量无法被 Prettier 修复的告警，因此显式关闭
+    for (const rule of [
+      'vue/attributes-order',
+      'vue/attribute-hyphenation',
+      'vue/require-default-prop',
+      'vue/multi-word-component-names',
+    ]) {
+      assert.strictEqual(rules[rule], 'off', `${rule} 应保持关闭`);
+    }
+
+    // 正确性与安全性规则应保留
+    assert.strictEqual(rules['vue/no-v-html'], 'warn');
+    assert.strictEqual(rules['vue/no-mutating-props'], 'error');
+  });
+});

package/flat/react.js

@@ -4,6 +4,26 @@ const jsxA11y = require('eslint-plugin-jsx-a11y');
 const tsParser = require('@typescript-eslint/parser');
 const { prettierOverrides } = require('./shared');
 
+/**
+ * React Hooks 经典规则
+ *
+ * eslint-plugin-react-hooks v7 的 `recommended` 预设新增了 14 条 React Compiler
+ * 相关规则（purity / immutability / refs / set-state-in-effect …），且大多为 error 级别。
+ * 这些规则用于配合 React Compiler 使用，在既有项目上会产生大量改动量极大的告警，
+ * 因此此处仅保留长期稳定、业界公认的两条经典规则；
+ * 需要启用编译器规则的项目可自行 extend：
+ *
+ *   import reactHooks from 'eslint-plugin-react-hooks';
+ *   export default [
+ *     ...vueConfig,
+ *     { plugins: { 'react-hooks': reactHooks }, rules: reactHooks.configs.recommended.rules },
+ *   ];
+ */
+const reactHooksRules = {
+  'react-hooks/rules-of-hooks': 'error',
+  'react-hooks/exhaustive-deps': 'warn',
+};
+
 /**
  * React Flat Config 配置
  */
@@ -27,7 +47,7 @@ module.exports = [
     },
     rules: {
       ...react.configs.recommended.rules,
-      ...reactHooks.configs.recommended.rules,
+      ...reactHooksRules,
       ...jsxA11y.configs.recommended.rules,
     },
   },

package/flat/vue.js

@@ -6,12 +6,16 @@ const { toArray, prettierOverrides } = require('./shared');
 /**
  * Vue Flat Config 配置
  *
- * - 使用 eslint-plugin-vue 官方的 flat/recommended 规则集
- * - <script> 按 lang 自动选择子解析器，因此 JS / TS 项目均可直接使用
+ * 规则档位选择 essential（而非 recommended）：
+ * eslint-plugin-vue 的 strongly-recommended / recommended 混入了大量格式类规则
+ * （attributes-order、attribute-hyphenation 等），它们无法被 Prettier 修复，
+ * 只会在扫描报告中长期堆积；真正有价值的正确性 / 安全规则已在下文显式开启。
+ *
+ * <script> 按 lang 自动选择子解析器，JS / TS / TSX 项目均可直接使用。
  */
 module.exports = [
   ...require('./index'),
-  ...toArray(vue.configs['flat/recommended']),
+  ...toArray(vue.configs['flat/essential']),
   {
     name: 'fe-spec/vue/parser',
     files: ['**/*.vue'],
@@ -35,5 +39,27 @@ module.exports = [
       },
     },
   },
+  {
+    name: 'fe-spec/vue/rules',
+    files: ['**/*.vue'],
+    rules: {
+      // 【保留】v-html 存在 XSS 风险，需显式确认
+      'vue/no-v-html': 'warn',
+      // 【保留】emits 显式声明，影响类型推导与可维护性
+      'vue/require-explicit-emits': 'warn',
+
+      // 【关闭】组件名常由路由 / 目录结构决定，index、App 类入口组件
+      // 必然为单词，强制多词会产生大量误报
+      'vue/multi-word-component-names': 'off',
+      // 【关闭】Vue2 时代规则：要求每个 prop 都有默认值。
+      // Vue3 使用 withDefaults(defineProps<T>())，可选 prop 由类型 `?` 表达
+      'vue/require-default-prop': 'off',
+      // 【关闭】属性命名风格（kebab-case）属团队约定，非正确性问题
+      'vue/attribute-hyphenation': 'off',
+      // 【关闭】属性排序属格式问题，Prettier 不处理，
+      // 开启会产生大量无法自动修复的告警
+      'vue/attributes-order': 'off',
+    },
+  },
   ...prettierOverrides(),
 ];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@huangjunsen/eslint-config",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "main": "index.js",
   "exports": {
     ".": "./index.js",
@@ -26,6 +26,15 @@
     "node",
     "lint"
   ],
+  "peerDependencies": {
+    "eslint": "^8.57.0 || ^9.0.0 || ^10.0.0",
+    "typescript": ">=4.8.4 <6.1.0"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
+  },
   "author": "Huangjunsen <951434130@qq.com>",
   "homepage": "https://github.com/Huang-junsen/js-encode-fe-spec#readme",
   "license": "ISC",
@@ -42,24 +51,23 @@
     "@babel/preset-react": "^7.24.1",
     "@typescript-eslint/eslint-plugin": "^8.70.0",
     "@typescript-eslint/parser": "^8.70.0",
-    "eslint-config-egg": "^13.1.0",
+    "eslint-config-egg": "^14.1.0",
     "eslint-config-prettier": "^10.1.8",
-    "eslint-import-resolver-typescript": "^3.6.1",
+    "eslint-import-resolver-typescript": "^4.4.5",
     "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-jsx-a11y": "^6.8.0",
-    "eslint-plugin-jsx-plus": "^0.1.0",
     "eslint-plugin-react": "^7.34.1",
-    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-react-hooks": "^7.1.1",
     "eslint-plugin-vue": "^10.11.0",
-    "globals": "^15.0.0",
+    "globals": "^17.12.0",
     "lodash": "^4.17.21",
     "typescript-eslint": "^8.70.0",
     "vue-eslint-parser": "^10.4.1"
   },
   "devDependencies": {
-    "eslint": "^8.7.0",
+    "eslint": "^8.57.0",
     "mocha": "^10.4.0",
-    "typescript": "5.0.4"
+    "typescript": "^5.0.4"
   },
   "scripts": {
     "lint": "eslint ./",

package/rules/react.js

@@ -91,9 +91,6 @@ module.exports = {
       },
     ],
 
-    // 本条废弃，用新规则代替 react/jsx-sort-props
-    'react/jsx-sort-prop-types': 'off',
-
     // 属性按首字母排序
     'react/jsx-sort-props': [
       'off',