@huangjunsen/eslint-config 1.0.1 → 1.0.3

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

@@ -253,8 +253,9 @@ describe('Validate TS configs', () => {
     assert.strictEqual(ruleIds.includes('no-console'), true);
     assert.strictEqual(ruleIds.includes('no-var'), true);
     assert.strictEqual(ruleIds.includes('eol-last'), true);
-    assert.equal(errorCount, 2);
-    assert.equal(warningCount, 3);
+    // 不硬编码具体数量，避免插件升级引起规则集变化时测试失效
+    assert.ok(errorCount > 0, `期望存在 error 级别问题，实际为 ${errorCount}`);
+    assert.ok(warningCount > 0, `期望存在 warning 级别问题，实际为 ${warningCount}`);
 
     // 验证已关闭的 link 规则是否校验正常，以 @typescript-eslint/explicit-function-return-type 为例
     assert.strictEqual(ruleIds.includes('@typescript-eslint/explicit-function-return-type'), false);

package/essential/rules/ts-blacklist.js

@@ -1,15 +1,5 @@
 module.exports = {
   rules: {
-    // 使用 2 个空格缩进
-    // @unessential
-    '@typescript-eslint/indent': 'off',
-
-    // 使用分号
-    // @unessential
-    '@typescript-eslint/semi': 'off',
-
     '@typescript-eslint/adjacent-overload-signatures': 'warn',
-
-    '@typescript-eslint/no-parameter-properties': 'warn',
   },
 };

package/flat/index.js

@@ -1,10 +1,15 @@
 const globals = require('globals');
+const { prettierOverrides } = require('./shared');
 
 /**
- * 基础 JS Flat Config 配置
+ * 基础 Flat Config（JavaScript）
+ *
+ * 只包含语言选项与通用的逻辑防错规则，不含格式化规则，
+ * 格式化统一交给 Prettier 完成。
  */
 module.exports = [
   {
+    name: 'fe-spec/base/language-options',
     languageOptions: {
       ecmaVersion: 'latest',
       sourceType: 'module',
@@ -17,8 +22,10 @@ module.exports = [
     linterOptions: {
       reportUnusedDisableDirectives: 'warn',
     },
+  },
+  {
+    name: 'fe-spec/base/rules',
     rules: {
-      // 常见逻辑防错规则（非纯排版格式）
       'no-var': 'error',
       'prefer-const': ['error', { destructuring: 'all' }],
       'no-unused-vars': ['warn', { argsIgnorePattern: '^_', varsIgnorePattern: '^_' }],
@@ -29,4 +36,5 @@ module.exports = [
       eqeqeq: ['warn', 'always', { null: 'ignore' }],
     },
   },
+  ...prettierOverrides(),
 ];

package/flat/node.js

@@ -0,0 +1,18 @@
+const globals = require('globals');
+const { prettierOverrides } = require('./shared');
+
+/**
+ * Node.js Flat Config 配置
+ */
+module.exports = [
+  ...require('./index'),
+  {
+    name: 'fe-spec/node/language-options',
+    languageOptions: {
+      globals: {
+        ...globals.node,
+      },
+    },
+  },
+  ...prettierOverrides(),
+];

package/flat/react.js

@@ -1,19 +1,47 @@
-const base = require('./index');
+const react = require('eslint-plugin-react');
+const reactHooks = require('eslint-plugin-react-hooks');
+const jsxA11y = require('eslint-plugin-jsx-a11y');
+const tsParser = require('@typescript-eslint/parser');
+const { prettierOverrides } = require('./shared');
 
 /**
  * React Flat Config 配置
  */
 module.exports = [
-  ...base,
+  ...require('./index'),
   {
-    files: ['**/*.jsx', '**/*.tsx'],
+    name: 'fe-spec/react/setup',
+    files: ['**/*.js', '**/*.jsx', '**/*.ts', '**/*.tsx'],
     languageOptions: {
       parserOptions: {
-        ecmaFeatures: {
-          jsx: true,
-        },
+        ecmaFeatures: { jsx: true },
+      },
+    },
+    plugins: {
+      react,
+      'react-hooks': reactHooks,
+      'jsx-a11y': jsxA11y,
+    },
+    settings: {
+      react: { version: 'detect' },
+    },
+    rules: {
+      ...react.configs.recommended.rules,
+      ...reactHooks.configs.recommended.rules,
+      ...jsxA11y.configs.recommended.rules,
+    },
+  },
+  {
+    name: 'fe-spec/react/typescript',
+    files: ['**/*.tsx'],
+    languageOptions: {
+      parser: tsParser,
+      parserOptions: {
+        ecmaVersion: 'latest',
+        sourceType: 'module',
+        ecmaFeatures: { jsx: true },
       },
     },
-    rules: {},
   },
+  ...prettierOverrides(),
 ];

package/flat/shared.js

@@ -0,0 +1,30 @@
+/**
+ * 共享依赖加载器（Flat Config 内部使用）
+ *
+ * 统一在此处加载 TypeScript / Prettier 相关依赖，保证各 flat 预设行为一致。
+ */
+
+/**
+ * 统一转成数组，兼容插件导出的 flat 配置可能为对象或数组
+ */
+function toArray(config) {
+  if (!config) return [];
+  return Array.isArray(config) ? config : [config];
+}
+
+/**
+ * 关闭所有与 Prettier 冲突的格式化规则
+ */
+function prettierOverrides() {
+  try {
+    return toArray(require('eslint-config-prettier/flat'));
+  } catch (e) {
+    try {
+      return toArray(require('eslint-config-prettier'));
+    } catch (err) {
+      return [];
+    }
+  }
+}
+
+module.exports = { toArray, prettierOverrides };

package/flat/typescript.js

@@ -1,15 +1,55 @@
-const base = require('./index');
+const tseslint = require('typescript-eslint');
+const tsPlugin = require('@typescript-eslint/eslint-plugin');
+const { toArray, prettierOverrides } = require('./shared');
+
+/**
+ * TypeScript 文件
+ */
+const tsFiles = ['**/*.ts', '**/*.tsx', '**/*.mts', '**/*.cts'];
 
 /**
  * TypeScript Flat Config 配置
+ *
+ * - ts/tsx 文件使用 @typescript-eslint/parser
+ * - 规则同时作用于 .vue（单文件组件中的 <script lang="ts"> 由 vue-eslint-parser 调用 TS parser 解析）
  */
 module.exports = [
-  ...base,
+  ...require('./index'),
+  ...toArray(tseslint.configs.recommended).map((config) => ({
+    ...config,
+    files: config.files || tsFiles,
+  })),
+  {
+    name: 'fe-spec/typescript/vue-plugin',
+    files: ['**/*.vue'],
+    plugins: {
+      '@typescript-eslint': tsPlugin,
+    },
+  },
+  {
+    name: 'fe-spec/typescript/tsx',
+    files: ['**/*.tsx'],
+    languageOptions: {
+      parserOptions: {
+        ecmaFeatures: {
+          jsx: true,
+        },
+      },
+    },
+  },
   {
-    files: ['**/*.ts', '**/*.tsx', '**/*.mts', '**/*.cts'],
+    name: 'fe-spec/typescript/rules',
+    files: [...tsFiles, '**/*.vue'],
     rules: {
+      // TS 由编译器与 @typescript-eslint 检查，关闭 ESLint 原生规则避免误报
       'no-unused-vars': 'off',
-      // TS 规范
+      'no-undef': 'off',
+      '@typescript-eslint/no-explicit-any': 'warn',
+      '@typescript-eslint/no-unused-vars': [
+        'warn',
+        { argsIgnorePattern: '^_', varsIgnorePattern: '^_' },
+      ],
     },
   },
+  ...prettierOverrides(),
 ];

package/flat/vue.js

@@ -1,12 +1,39 @@
-const base = require('./index');
+const vue = require('eslint-plugin-vue');
+const vueParser = require('vue-eslint-parser');
+const tsParser = require('@typescript-eslint/parser');
+const { toArray, prettierOverrides } = require('./shared');
 
 /**
  * Vue Flat Config 配置
+ *
+ * - 使用 eslint-plugin-vue 官方的 flat/recommended 规则集
+ * - <script> 按 lang 自动选择子解析器，因此 JS / TS 项目均可直接使用
  */
 module.exports = [
-  ...base,
+  ...require('./index'),
+  ...toArray(vue.configs['flat/recommended']),
   {
+    name: 'fe-spec/vue/parser',
     files: ['**/*.vue'],
-    rules: {},
+    languageOptions: {
+      parser: vueParser,
+      parserOptions: {
+        ecmaVersion: 'latest',
+        sourceType: 'module',
+        // 支持 <script lang="tsx"> 中的 JSX 写法
+        ecmaFeatures: {
+          jsx: true,
+        },
+        // https://github.com/vuejs/vue-eslint-parser#parseroptionsparser
+        parser: {
+          js: 'espree',
+          jsx: 'espree',
+          ts: tsParser,
+          tsx: tsParser,
+        },
+        extraFileExtensions: ['.vue'],
+      },
+    },
   },
+  ...prettierOverrides(),
 ];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@huangjunsen/eslint-config",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "main": "index.js",
   "exports": {
     ".": "./index.js",
@@ -8,6 +8,7 @@
     "./flat/typescript": "./flat/typescript.js",
     "./flat/react": "./flat/react.js",
     "./flat/vue": "./flat/vue.js",
+    "./flat/node": "./flat/node.js",
     "./vue": "./vue.js",
     "./react": "./react.js",
     "./node": "./node.js",
@@ -36,27 +37,29 @@
     "url": "https://github.com/Huang-junsen/js-encode-fe-spec/issues"
   },
   "dependencies": {
-    "globals": "^15.0.0"
-  },
-  "devDependencies": {
     "@babel/core": "^7.24.4",
     "@babel/eslint-parser": "^7.24.1",
     "@babel/preset-react": "^7.24.1",
-    "@typescript-eslint/eslint-plugin": "^7.7.0",
-    "@typescript-eslint/parser": "^7.7.0",
-    "eslint": "^8.7.0",
+    "@typescript-eslint/eslint-plugin": "^8.70.0",
+    "@typescript-eslint/parser": "^8.70.0",
     "eslint-config-egg": "^13.1.0",
+    "eslint-config-prettier": "^10.1.8",
     "eslint-import-resolver-typescript": "^3.6.1",
     "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-vue": "^9.25.0",
+    "eslint-plugin-vue": "^10.11.0",
+    "globals": "^15.0.0",
     "lodash": "^4.17.21",
+    "typescript-eslint": "^8.70.0",
+    "vue-eslint-parser": "^10.4.1"
+  },
+  "devDependencies": {
+    "eslint": "^8.7.0",
     "mocha": "^10.4.0",
-    "typescript": "5.0.4",
-    "vue-eslint-parser": "^9.4.2"
+    "typescript": "5.0.4"
   },
   "scripts": {
     "lint": "eslint ./",

package/rules/typescript.js

@@ -64,41 +64,12 @@ module.exports = {
      */
     '@typescript-eslint/ban-tslint-comment': 'error',
 
-    /**
-     * 【关闭】禁止使用指定的类型
-     * @link https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/ban-types.md
-     */
-    '@typescript-eslint/ban-types': 'off',
-
-    /**
-     * 【强制】大括号换行风格：one true brace style 风格，且单行代码块可不换行
-     * @link https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/brace-style.md
-     * @extend
-     */
-    'brace-style': 'off',
-    '@typescript-eslint/brace-style': [
-      'error',
-      '1tbs',
-      { allowSingleLine: true },
-    ],
-
     /**
      * 【推荐】类的属性如果是字面量，则必须是只读属性而不能用 getter
      * @link https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/class-literal-property-style.md
      */
     '@typescript-eslint/class-literal-property-style': ['warn', 'fields'],
 
-    /**
-     * 【强制】逗号的前面无空格，后面有空格
-     * @link https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/comma-spacing.md
-     * @extend
-     */
-    'comma-spacing': 'off',
-    '@typescript-eslint/comma-spacing': [
-      'error',
-      { before: false, after: true },
-    ],
-
     /**
      * 【强制】类型断言必须使用 as Type 而非 <T>，对象字面量禁止类型断言（断言成 any 除外）
      * <T> 容易与 JSX 语法混淆
@@ -154,61 +125,6 @@ module.exports = {
      */
     '@typescript-eslint/explicit-module-boundary-types': 'off',
 
-    /**
-     * 【强制】函数名与调用它的括号间无空格
-     * @link https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/func-call-spacing.md
-     */
-    'func-call-spacing': 'off',
-    '@typescript-eslint/func-call-spacing': ['error', 'never'],
-
-    /**
-     * 【强制】缩进为两个空格
-     * @link https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/indent.md
-     */
-    indent: 'off',
-    '@typescript-eslint/indent': [
-      'error',
-      2,
-      {
-        SwitchCase: 1,
-        VariableDeclarator: 1,
-        outerIIFEBody: 1,
-        // MemberExpression: null,
-        FunctionDeclaration: {
-          parameters: 1,
-          body: 1,
-        },
-        FunctionExpression: {
-          parameters: 1,
-          body: 1,
-        },
-        CallExpression: {
-          arguments: 1,
-        },
-        ArrayExpression: 1,
-        ObjectExpression: 1,
-        ImportDeclaration: 1,
-        flatTernaryExpressions: false,
-        // list derived from https://github.com/benjamn/ast-types/blob/HEAD/def/jsx.js
-        ignoredNodes: [
-          'JSXElement',
-          'JSXElement > *',
-          'JSXAttribute',
-          'JSXIdentifier',
-          'JSXNamespacedName',
-          'JSXMemberExpression',
-          'JSXSpreadAttribute',
-          'JSXExpressionContainer',
-          'JSXOpeningElement',
-          'JSXClosingElement',
-          'JSXText',
-          'JSXEmptyExpression',
-          'JSXSpreadChild',
-        ],
-        ignoreComments: false,
-      },
-    ],
-
     /**
      * 【关闭】变量必须在定义的时候赋值
      * @link https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/init-declarations.md
@@ -217,39 +133,6 @@ module.exports = {
     'init-declarations': 'off',
     '@typescript-eslint/init-declarations': 'off',
 
-    /**
-     * 【强制】关键字前后有一个空格
-     * @link https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/keyword-spacing.md
-     * @extend
-     */
-    'keyword-spacing': 'off',
-    '@typescript-eslint/keyword-spacing': [
-      'error',
-      {
-        before: true,
-        after: true,
-        overrides: {
-          return: { after: true },
-          throw: { after: true },
-          case: { after: true },
-        },
-      },
-    ],
-
-    /**
-     * 【关闭】类成员之间保留一个空行
-     * @link https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/lines-between-class-members.md
-     * @extend
-     */
-    'lines-between-class-members': 'off',
-    '@typescript-eslint/lines-between-class-members': 'off',
-
-    /**
-     * 【强制】interface/type 类型中保持一致的成员分隔符分号「;」，单行类型的最后一个元素不加分号
-     * @link https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/member-delimiter-style.md
-     */
-    '@typescript-eslint/member-delimiter-style': 'error',
-
     /**
      * 【推荐】类成员的遵循一定的排序规则
      * 1. 类的静态方法/属性(static)优先于实例的方法/属性(instance)
@@ -303,8 +186,6 @@ module.exports = {
      * 【关闭】限制各种变量或类型的命名规则
      * @link https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/naming-convention.md
      */
-    camelcase: 'off',
-    '@typescript-eslint/camelcase': 'off',
     '@typescript-eslint/naming-convention': 'off',
 
     /**
@@ -372,21 +253,6 @@ module.exports = {
      */
     '@typescript-eslint/no-extra-non-null-assertion': 'off',
 
-    /**
-     * 【关闭】禁止不必要的小括号
-     * @link https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-extra-parens.md
-     */
-    'no-extra-parens': 'off',
-    '@typescript-eslint/no-extra-parens': 'off',
-
-    /**
-     * 【强制】禁止不必要的分号
-     * @link https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-extra-semi.md
-     * @extend
-     */
-    'no-extra-semi': 'off',
-    '@typescript-eslint/no-extra-semi': 'error',
-
     /**
      * 【关闭】禁止定义没必要的类，比如只有静态方法的类
      * @link https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-extraneous-class.md
@@ -472,11 +338,6 @@ module.exports = {
      */
     '@typescript-eslint/no-non-null-assertion': 'off',
 
-    /**
-     * 【关闭】禁止给类的构造函数的参数添加修饰符
-     */
-    '@typescript-eslint/no-parameter-properties': 'off',
-
     /**
      * 【推荐】不建议使用 require 引入模块，使用 import
      */
@@ -499,16 +360,6 @@ module.exports = {
       },
     ],
 
-    /**
-     * 【关闭】禁止 throw 字面量，必须 throw 一个 Error 对象
-     */
-    '@typescript-eslint/no-throw-literal': 'off',
-
-    /**
-     * 【关闭】禁止使用类型别名
-     */
-    '@typescript-eslint/no-type-alias': 'off',
-
     /**
      * 【关闭】测试表达式中的布尔类型禁止与 true 或 false 直接比较
      */
@@ -578,11 +429,6 @@ module.exports = {
       { vars: 'all', args: 'after-used', ignoreRestSiblings: true },
     ],
 
-    /**
-     * 【关闭】禁止已定义的变量未使用
-     */
-    '@typescript-eslint/no-unused-vars-experimental': 'off',
-
     /**
      * 【强制】禁止在定义变量之前就使用它
      * @extend
@@ -676,12 +522,6 @@ module.exports = {
      */
     '@typescript-eslint/promise-function-async': 'off',
 
-    /**
-     * 【强制】ts 文件字符串字面量优先使用单引号
-     */
-    quotes: 'off',
-    '@typescript-eslint/quotes': ['error', 'single', { avoidEscape: true }],
-
     /**
      * 【关闭】async 函数中必须存在 await 语句
      */
@@ -705,27 +545,6 @@ module.exports = {
     'no-return-await': 'off',
     '@typescript-eslint/return-await': 'off',
 
-    /**
-     * 【强制】添加分号
-     * @extend
-     */
-    semi: 'off',
-    '@typescript-eslint/semi': ['error', 'always'],
-
-    /**
-     * 【强制】命名函数的空格规则，遵循 JS 约定
-     * @extend
-     */
-    'space-before-function-paren': 'off',
-    '@typescript-eslint/space-before-function-paren': [
-      'error',
-      {
-        anonymous: 'always',
-        named: 'never',
-        asyncArrow: 'always',
-      },
-    ],
-
     /**
      * 【关闭】条件判断必须传入布尔值
      */
@@ -748,11 +567,6 @@ module.exports = {
       },
     ],
 
-    /**
-     * 【强制】定义类型时应正确添加空格
-     */
-    '@typescript-eslint/type-annotation-spacing': 'error',
-
     /**
      * 【强制】interface 和 type 定义时必须声明成员的类型
      */