@huangjunsen/eslint-config 1.0.0 → 1.0.2

package/essential/react.js

@@ -1,76 +1,76 @@
-module.exports = {
-  extends: [
-    '../react',
-    './rules/set-style-to-warn',
-    './rules/blacklist',
-    './rules/es6-blacklist',
-  ].map(require.resolve),
-  rules: {
-    // 标签的属性有多行时，结束标签需另起一行
-    // @unessential
-    'react/jsx-closing-bracket-location': ['warn', 'line-aligned'],
-
-    // JSX 语法闭合标签的缩进和换行
-    // @unessential
-    'react/jsx-closing-tag-location': 'warn',
-
-    // JSX 行内属性间仅有一个空格
-    // @unessential
-    'react/jsx-props-no-multi-spaces': 'warn',
-
-    // JSX 属性的大括号内部两侧无空格
-    // @unessential
-    'react/jsx-curly-spacing': ['warn', 'never', { allowMultiline: true }],
-
-    // JSX 属性使用 2 个空格缩进
-    // @unessential
-    'react/jsx-indent-props': ['off', 2],
-
-    // 标签属性的换行，如果标签有多个属性，且存在换行，则每个属性都需要换行独占一行
-    // @unessential
-    'react/jsx-max-props-per-line': ['warn', { maximum: 1, when: 'multiline' }],
-
-    // 禁止使用已经废弃的方法
-    // @unessential
-    'react/no-deprecated': 'warn',
-
-    // 多行的 JSX 标签需用小括号包裹
-    // @unessential
-    'react/jsx-wrap-multilines': [
-      'warn',
-      {
-        declaration: true,
-        assignment: true,
-        return: true,
-        arrow: true,
-      },
-    ],
-
-    // 设置第一个属性的位置。multiline-multiprop：如果JSX标签占用多行并且有多个属性，则第一个属性应始终放在新行上
-    // @unessential
-    'react/jsx-first-prop-new-line': ['warn', 'multiline-multiprop'],
-
-    // 不要在 JSX 属性的等号两边加空格
-    // @unessential
-    'react/jsx-equals-spacing': ['warn', 'never'],
-
-    // JSX 使用 2 个空格缩进
-    // @unessential
-    'react/jsx-indent': ['off', 2],
-
-    // 不要使用 findDOMNode，严格模式下已经弃用
-    // @unessential
-    'react/no-find-dom-node': 'warn',
-
-    // 自闭合标签的斜线前有且仅有一个空格
-    // @unessential
-    'react/jsx-tag-spacing': [
-      'warn',
-      {
-        closingSlash: 'never',
-        beforeSelfClosing: 'always',
-        afterOpening: 'never',
-      },
-    ],
-  },
-};
+module.exports = {
+  extends: [
+    '../react',
+    './rules/set-style-to-warn',
+    './rules/blacklist',
+    './rules/es6-blacklist',
+  ].map(require.resolve),
+  rules: {
+    // 标签的属性有多行时，结束标签需另起一行
+    // @unessential
+    'react/jsx-closing-bracket-location': ['warn', 'line-aligned'],
+
+    // JSX 语法闭合标签的缩进和换行
+    // @unessential
+    'react/jsx-closing-tag-location': 'warn',
+
+    // JSX 行内属性间仅有一个空格
+    // @unessential
+    'react/jsx-props-no-multi-spaces': 'warn',
+
+    // JSX 属性的大括号内部两侧无空格
+    // @unessential
+    'react/jsx-curly-spacing': ['warn', 'never', { allowMultiline: true }],
+
+    // JSX 属性使用 2 个空格缩进
+    // @unessential
+    'react/jsx-indent-props': ['off', 2],
+
+    // 标签属性的换行，如果标签有多个属性，且存在换行，则每个属性都需要换行独占一行
+    // @unessential
+    'react/jsx-max-props-per-line': ['warn', { maximum: 1, when: 'multiline' }],
+
+    // 禁止使用已经废弃的方法
+    // @unessential
+    'react/no-deprecated': 'warn',
+
+    // 多行的 JSX 标签需用小括号包裹
+    // @unessential
+    'react/jsx-wrap-multilines': [
+      'warn',
+      {
+        declaration: true,
+        assignment: true,
+        return: true,
+        arrow: true,
+      },
+    ],
+
+    // 设置第一个属性的位置。multiline-multiprop：如果JSX标签占用多行并且有多个属性，则第一个属性应始终放在新行上
+    // @unessential
+    'react/jsx-first-prop-new-line': ['warn', 'multiline-multiprop'],
+
+    // 不要在 JSX 属性的等号两边加空格
+    // @unessential
+    'react/jsx-equals-spacing': ['warn', 'never'],
+
+    // JSX 使用 2 个空格缩进
+    // @unessential
+    'react/jsx-indent': ['off', 2],
+
+    // 不要使用 findDOMNode，严格模式下已经弃用
+    // @unessential
+    'react/no-find-dom-node': 'warn',
+
+    // 自闭合标签的斜线前有且仅有一个空格
+    // @unessential
+    'react/jsx-tag-spacing': [
+      'warn',
+      {
+        closingSlash: 'never',
+        beforeSelfClosing: 'always',
+        afterOpening: 'never',
+      },
+    ],
+  },
+};

package/essential/rules/blacklist.js

@@ -1,48 +1,48 @@
-module.exports = {
-  rules: {
-    // 统一在点号之前换行
-    // @unessential
-    'dot-location': ['warn', 'property'],
-
-    // 禁止使用 eval
-    // @unessential 部分场景必须使用 eval
-    'no-eval': 'warn',
-
-    // 禁止使用类 eval 的方法，如 setTimeout 传入字符串
-    // @unessential
-    'no-implied-eval': 'warn',
-
-    // 禁止使用 javascript:url，如 location.href = 'javascript:void(0)';
-    // @unessential
-    'no-script-url': 'warn',
-
-    // 禁止变量与外层作用域已存在的变量同名
-    // @unessential
-    'no-shadow': 'warn',
-
-    // 禁止出现多个连续空格
-    // @unessential
-    'no-multi-spaces': [
-      'warn',
-      {
-        ignoreEOLComments: false,
-      },
-    ],
-
-    // 使用 2 个空格缩进
-    // @unessential
-    indent: 'off',
-
-    // 使用分号
-    // @unessential
-    semi: 'off',
-
-    // 分号必须写在行尾
-    // @unessential
-    'semi-style': 'off',
-
-    // 不要直接在对象上调用 Object.prototypes 上的方法
-    // @unessential
-    'no-prototype-builtins': 'warn',
-  },
-};
+module.exports = {
+  rules: {
+    // 统一在点号之前换行
+    // @unessential
+    'dot-location': ['warn', 'property'],
+
+    // 禁止使用 eval
+    // @unessential 部分场景必须使用 eval
+    'no-eval': 'warn',
+
+    // 禁止使用类 eval 的方法，如 setTimeout 传入字符串
+    // @unessential
+    'no-implied-eval': 'warn',
+
+    // 禁止使用 javascript:url，如 location.href = 'javascript:void(0)';
+    // @unessential
+    'no-script-url': 'warn',
+
+    // 禁止变量与外层作用域已存在的变量同名
+    // @unessential
+    'no-shadow': 'warn',
+
+    // 禁止出现多个连续空格
+    // @unessential
+    'no-multi-spaces': [
+      'warn',
+      {
+        ignoreEOLComments: false,
+      },
+    ],
+
+    // 使用 2 个空格缩进
+    // @unessential
+    indent: 'off',
+
+    // 使用分号
+    // @unessential
+    semi: 'off',
+
+    // 分号必须写在行尾
+    // @unessential
+    'semi-style': 'off',
+
+    // 不要直接在对象上调用 Object.prototypes 上的方法
+    // @unessential
+    'no-prototype-builtins': 'warn',
+  },
+};

package/essential/rules/es6-blacklist.js

@@ -1,62 +1,62 @@
-module.exports = {
-  rules: {
-    // 箭头函数的箭头前后各留一个空格
-    // @unessential
-    'arrow-spacing': ['warn', { before: true, after: true }],
-
-    // generator 函数的 * 号前面无空格，后面有一个空格
-    // @unessential
-    'generator-star-spacing': ['warn', { before: false, after: true }],
-
-    // 避免箭头函数与比较操作符产生混淆
-    // @unessential
-    'no-confusing-arrow': 'warn',
-
-    // 回调函数使用箭头函数而不是匿名函数
-    // @unessential
-    'prefer-arrow-callback': [
-      'warn',
-      {
-        allowNamedFunctions: false,
-        allowUnboundThis: true,
-      },
-    ],
-
-    // 优先使用 const，只有当变量会被重新赋值时才使用 let
-    // @unessential
-    'prefer-const': [
-      'warn',
-      {
-        destructuring: 'any',
-        ignoreReadBeforeAssign: true,
-      },
-    ],
-
-    // 模板字符串中的大括号内部两侧无空格
-    // @unessential
-    'template-curly-spacing': 'warn',
-
-    // yield* 表达式的 * 号前面无空格，后面有一个空格
-    // @unessential
-    'yield-star-spacing': ['warn', 'after'],
-
-    // import 语句需要放到模块的最上方
-    // @unessential
-    'import/first': 'warn',
-
-    // 使用对象属性和方法的简写语法
-    // @unessential
-    'object-shorthand': [
-      'warn',
-      'always',
-      {
-        ignoreConstructors: false,
-        avoidQuotes: true,
-      },
-    ],
-
-    // 使用 const 或 let 声明变量，不要使用 var
-    // @unessential
-    'no-var': 'warn',
-  },
-};
+module.exports = {
+  rules: {
+    // 箭头函数的箭头前后各留一个空格
+    // @unessential
+    'arrow-spacing': ['warn', { before: true, after: true }],
+
+    // generator 函数的 * 号前面无空格，后面有一个空格
+    // @unessential
+    'generator-star-spacing': ['warn', { before: false, after: true }],
+
+    // 避免箭头函数与比较操作符产生混淆
+    // @unessential
+    'no-confusing-arrow': 'warn',
+
+    // 回调函数使用箭头函数而不是匿名函数
+    // @unessential
+    'prefer-arrow-callback': [
+      'warn',
+      {
+        allowNamedFunctions: false,
+        allowUnboundThis: true,
+      },
+    ],
+
+    // 优先使用 const，只有当变量会被重新赋值时才使用 let
+    // @unessential
+    'prefer-const': [
+      'warn',
+      {
+        destructuring: 'any',
+        ignoreReadBeforeAssign: true,
+      },
+    ],
+
+    // 模板字符串中的大括号内部两侧无空格
+    // @unessential
+    'template-curly-spacing': 'warn',
+
+    // yield* 表达式的 * 号前面无空格，后面有一个空格
+    // @unessential
+    'yield-star-spacing': ['warn', 'after'],
+
+    // import 语句需要放到模块的最上方
+    // @unessential
+    'import/first': 'warn',
+
+    // 使用对象属性和方法的简写语法
+    // @unessential
+    'object-shorthand': [
+      'warn',
+      'always',
+      {
+        ignoreConstructors: false,
+        avoidQuotes: true,
+      },
+    ],
+
+    // 使用 const 或 let 声明变量，不要使用 var
+    // @unessential
+    'no-var': 'warn',
+  },
+};

package/essential/rules/set-style-to-warn.js

@@ -1,30 +1,30 @@
-/**
- * 将 error 级别的 style 规则降级为 warn
- */
-
-// 将传入 config 中 error 级别规则都改为 warn 级别
-function setErrorRulesToWarn(configPath) {
-  const config = require(configPath);
-  const { rules } = config;
-
-  for (const ruleName in rules) {
-    if (Object.prototype.hasOwnProperty.call(rules, ruleName)) {
-      const ruleValue = rules[ruleName];
-      if (Array.isArray(ruleValue)) {
-        // 'array-bracket-spacing': [ 'error', 'never' ] 这种规则写法
-        if (ruleValue[0] === 'error') {
-          ruleValue[0] = 'warn';
-        }
-      } else if (ruleValue === 'error') {
-        // 'new-parens': 'error' 这种规则写法
-        rules[ruleName] = 'warn';
-      }
-    }
-  }
-
-  return {
-    rules,
-  };
-}
-
-module.exports = setErrorRulesToWarn('../../rules/base/style.js');
+/**
+ * 将 error 级别的 style 规则降级为 warn
+ */
+
+// 将传入 config 中 error 级别规则都改为 warn 级别
+function setErrorRulesToWarn(configPath) {
+  const config = require(configPath);
+  const { rules } = config;
+
+  for (const ruleName in rules) {
+    if (Object.prototype.hasOwnProperty.call(rules, ruleName)) {
+      const ruleValue = rules[ruleName];
+      if (Array.isArray(ruleValue)) {
+        // 'array-bracket-spacing': [ 'error', 'never' ] 这种规则写法
+        if (ruleValue[0] === 'error') {
+          ruleValue[0] = 'warn';
+        }
+      } else if (ruleValue === 'error') {
+        // 'new-parens': 'error' 这种规则写法
+        rules[ruleName] = 'warn';
+      }
+    }
+  }
+
+  return {
+    rules,
+  };
+}
+
+module.exports = setErrorRulesToWarn('../../rules/base/style.js');

package/essential/rules/ts-blacklist.js

@@ -1,15 +1,15 @@
-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',
-  },
-};
+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/essential/typescript/index.js

@@ -1,7 +1,7 @@
-module.exports = {
-  extends: [
-    '../index',
-    '../../rules/typescript',
-    '../rules/ts-blacklist',
-  ].map(require.resolve),
-};
+module.exports = {
+  extends: [
+    '../index',
+    '../../rules/typescript',
+    '../rules/ts-blacklist',
+  ].map(require.resolve),
+};

package/essential/typescript/react.js

@@ -1,7 +1,7 @@
-module.exports = {
-  extends: [
-    '../react',
-    '../../rules/typescript',
-    '../rules/ts-blacklist',
-  ].map(require.resolve),
-};
+module.exports = {
+  extends: [
+    '../react',
+    '../../rules/typescript',
+    '../rules/ts-blacklist',
+  ].map(require.resolve),
+};

package/essential/typescript/vue.js

@@ -1,9 +1,9 @@
-module.exports = {
-  extends: [
-    './index',
-    '../../rules/vue', // vue 要置于最后，因为里面用了 vue-parser
-  ].map(require.resolve),
-  parserOptions: {
-    parser: '@typescript-eslint/parser',
-  },
-};
+module.exports = {
+  extends: [
+    './index',
+    '../../rules/vue', // vue 要置于最后，因为里面用了 vue-parser
+  ].map(require.resolve),
+  parserOptions: {
+    parser: '@typescript-eslint/parser',
+  },
+};

package/essential/vue.js

@@ -1,8 +1,8 @@
-module.exports = {
-  extends: [
-    '../vue',
-    './rules/set-style-to-warn',
-    './rules/blacklist',
-    './rules/es6-blacklist',
-  ].map(require.resolve),
-};
+module.exports = {
+  extends: [
+    '../vue',
+    './rules/set-style-to-warn',
+    './rules/blacklist',
+    './rules/es6-blacklist',
+  ].map(require.resolve),
+};

package/flat/index.js

@@ -0,0 +1,32 @@
+const globals = require('globals');
+
+/**
+ * 基础 JS Flat Config 配置
+ */
+module.exports = [
+  {
+    languageOptions: {
+      ecmaVersion: 'latest',
+      sourceType: 'module',
+      globals: {
+        ...globals.browser,
+        ...globals.node,
+        ...globals.es2021,
+      },
+    },
+    linterOptions: {
+      reportUnusedDisableDirectives: 'warn',
+    },
+    rules: {
+      // 常见逻辑防错规则（非纯排版格式）
+      'no-var': 'error',
+      'prefer-const': ['error', { destructuring: 'all' }],
+      'no-unused-vars': ['warn', { argsIgnorePattern: '^_', varsIgnorePattern: '^_' }],
+      'no-constant-condition': 'warn',
+      'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'warn',
+      'no-console': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
+      'no-duplicate-imports': 'error',
+      eqeqeq: ['warn', 'always', { null: 'ignore' }],
+    },
+  },
+];

package/flat/react.js

@@ -0,0 +1,19 @@
+const base = require('./index');
+
+/**
+ * React Flat Config 配置
+ */
+module.exports = [
+  ...base,
+  {
+    files: ['**/*.jsx', '**/*.tsx'],
+    languageOptions: {
+      parserOptions: {
+        ecmaFeatures: {
+          jsx: true,
+        },
+      },
+    },
+    rules: {},
+  },
+];

package/flat/typescript.js

@@ -0,0 +1,15 @@
+const base = require('./index');
+
+/**
+ * TypeScript Flat Config 配置
+ */
+module.exports = [
+  ...base,
+  {
+    files: ['**/*.ts', '**/*.tsx', '**/*.mts', '**/*.cts'],
+    rules: {
+      'no-unused-vars': 'off',
+      // TS 规范
+    },
+  },
+];

package/flat/vue.js

@@ -0,0 +1,12 @@
+const base = require('./index');
+
+/**
+ * Vue Flat Config 配置
+ */
+module.exports = [
+  ...base,
+  {
+    files: ['**/*.vue'],
+    rules: {},
+  },
+];

package/index.js

@@ -1,23 +1,23 @@
-module.exports = {
-  extends: [
-    './rules/base/best-practices',
-    './rules/base/possible-errors',
-    './rules/base/style',
-    './rules/base/variables',
-    './rules/base/es6',
-    './rules/base/strict',
-    './rules/imports',
-  ].map(require.resolve),
-  parser: '@babel/eslint-parser',
-  parserOptions: {
-    requireConfigFile: false,
-    ecmaVersion: 2020,
-    sourceType: 'module',
-    ecmaFeatures: {
-      globalReturn: false,
-      impliedStrict: true,
-      jsx: true,
-    },
-  },
-  root: true,
-};
+module.exports = {
+  extends: [
+    './rules/base/best-practices',
+    './rules/base/possible-errors',
+    './rules/base/style',
+    './rules/base/variables',
+    './rules/base/es6',
+    './rules/base/strict',
+    './rules/imports',
+  ].map(require.resolve),
+  parser: '@babel/eslint-parser',
+  parserOptions: {
+    requireConfigFile: false,
+    ecmaVersion: 2020,
+    sourceType: 'module',
+    ecmaFeatures: {
+      globalReturn: false,
+      impliedStrict: true,
+      jsx: true,
+    },
+  },
+  root: true,
+};