@huangjunsen/eslint-config 1.0.0

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

@@ -0,0 +1,263 @@
+/**
+ * 验证 TS 规则
+ */
+
+const assert = require('assert');
+const eslint = require('eslint');
+const path = require('path');
+const sumBy = require('lodash/sumBy');
+
+function isObject(obj) {
+  return typeof obj === 'object' && obj !== null;
+}
+
+describe('Validate TS configs', () => {
+  it('Validate eslint-config-encode/typescript', async () => {
+    const configPath = './typescript/index.js';
+    const filePath = path.join(__dirname, './fixtures/ts.ts');
+
+    const cli = new eslint.ESLint({
+      overrideConfigFile: configPath,
+      useEslintrc: false,
+      ignore: false,
+      overrideConfig: {
+        parserOptions: {
+          project: path.join(__dirname, './fixtures/tsconfig.json'),
+        },
+      },
+    });
+
+    // 验证导出的 config 是否正常
+    const config = cli.calculateConfigForFile(filePath);
+    assert.ok(isObject(config));
+
+    // 验证 lint 工作是否正常
+    const results = await cli.lintFiles([filePath]);
+    assert.equal(sumBy(results, 'fatalErrorCount'), 0);
+    assert.notEqual(sumBy(results, 'errorCount'), 0);
+    assert.equal(sumBy(results, 'warningCount'), 0);
+
+    // 验证 eslint-plugin-typescript 工作是否正常
+    const { messages } = results[0];
+    const errorReportedByReactPlugin = messages.filter((result) => {
+      return result.ruleId && result.ruleId.indexOf('@typescript-eslint/') !== -1;
+    });
+    assert.notEqual(errorReportedByReactPlugin.length, 0);
+
+    const errorReportedByNoRedeclare = messages.filter((result) => {
+      return result.ruleId === 'no-redeclare';
+    });
+    assert.equal(errorReportedByNoRedeclare.length, 0);
+
+    // 验证 eslint-import-resolver-typescript 工作是否正常
+    const filePath2 = path.join(__dirname, './fixtures/ts-import-a.ts');
+    const filePath3 = path.join(__dirname, './fixtures/ts-import-b.ts');
+    const reports2 = cli.lintFiles([filePath2, filePath3]);
+    assert.ok(reports2.errorCount !== 0 || reports2.warnCount !== 0);
+  });
+
+  it('Validate eslint-config-encode/typescript/vue', async () => {
+    const configPath = './typescript/vue.js';
+    const filePath = path.join(__dirname, './fixtures/ts-vue.vue');
+
+    const cli = new eslint.ESLint({
+      overrideConfigFile: configPath,
+      useEslintrc: false,
+      ignore: false,
+      overrideConfig: {
+        parserOptions: {
+          project: path.join(__dirname, './fixtures/tsconfig.json'),
+        },
+      },
+    });
+
+    // 验证导出的 config 是否正常
+    const config = await cli.calculateConfigForFile(filePath);
+    assert.ok(isObject(config));
+
+    // 验证 lint 工作是否正常
+    const results = await cli.lintFiles([filePath]);
+    assert.equal(sumBy(results, 'fatalErrorCount'), 0);
+    assert.notEqual(sumBy(results, 'errorCount'), 0);
+    assert.notEqual(sumBy(results, 'warningCount'), 0);
+
+    // 验证 eslint-plugin-vue 及 @typescript-eslint 工作是否正常
+    const { messages } = results[0];
+    const errorReportedByReactPlugin = messages.filter((result) => {
+      return result.ruleId && result.ruleId.indexOf('vue/') !== -1;
+    });
+    const errorReportedByTSPlugin = messages.filter((result) => {
+      return result.ruleId && result.ruleId.indexOf('@typescript-eslint/') !== -1;
+    });
+    assert.notEqual(errorReportedByReactPlugin.length, 0);
+    assert.notEqual(errorReportedByTSPlugin.length, 0);
+  });
+
+  it('Validate eslint-config-encode/essential/typescript', async () => {
+    const configPath = './essential/typescript/index.js';
+    const filePath = path.join(__dirname, './fixtures/ts.ts');
+
+    const cli = new eslint.ESLint({
+      overrideConfigFile: configPath,
+      useEslintrc: false,
+      ignore: false,
+      overrideConfig: {
+        parserOptions: {
+          project: path.join(__dirname, './fixtures/tsconfig.json'),
+        },
+      },
+    });
+
+    // 验证导出的 config 是否正常
+    const config = await cli.calculateConfigForFile(filePath);
+    assert.ok(isObject(config));
+
+    // 验证 lint 工作是否正常
+    const results = await cli.lintFiles([filePath]);
+    assert.equal(sumBy(results, 'fatalErrorCount'), 0);
+    assert.notEqual(sumBy(results, 'errorCount'), 0);
+    assert.notEqual(sumBy(results, 'warningCount'), 0);
+
+    // 验证黑名单中的规则已关闭
+    const { messages } = results[0];
+
+    // 验证 @typescript-eslint/semi 被关闭
+    const semiErrors = messages.filter((result) => {
+      return result.ruleId === '@typescript-eslint/semi';
+    });
+    assert.equal(semiErrors.length, 0);
+
+    // 验证一个风格问题被降级
+    const styleErrors = messages.filter((result) => {
+      return result.ruleId === 'object-curly-spacing';
+    });
+    assert.equal(styleErrors[0].severity, 1);
+  });
+
+  it('Validate eslint-config-encode/essential/typescript/react', async () => {
+    const configPath = './essential/typescript/react.js';
+    const filePath = path.join(__dirname, './fixtures/ts-react.tsx');
+
+    const cli = new eslint.ESLint({
+      overrideConfigFile: configPath,
+      useEslintrc: false,
+      ignore: false,
+      overrideConfig: {
+        parserOptions: {
+          project: path.join(__dirname, './fixtures/tsconfig.json'),
+        },
+      },
+    });
+
+    // 验证导出的 config 是否正常
+    const config = await cli.calculateConfigForFile(filePath);
+    assert.ok(isObject(config));
+
+    // 验证 lint 工作是否正常
+    const results = await cli.lintFiles([filePath]);
+    assert.equal(sumBy(results, 'fatalErrorCount'), 0);
+    assert.notEqual(sumBy(results, 'errorCount'), 0);
+    assert.notEqual(sumBy(results, 'warningCount'), 0);
+
+    // 验证对 tsx 工作是否正常
+    const { messages } = results[0];
+    const errorReportedByReactPlugin = messages.filter((result) => {
+      return result.ruleId && result.ruleId.indexOf('react/') !== -1;
+    });
+    assert.notEqual(errorReportedByReactPlugin.length, 0);
+    const errorReportedByTSPlugin = messages.filter((result) => {
+      return result.ruleId && result.ruleId.indexOf('@typescript-eslint/') !== -1;
+    });
+    assert.notEqual(errorReportedByTSPlugin.length, 0);
+
+    // 验证 @typescript-eslint/semi 被关闭
+    const semiErrors = messages.filter((result) => {
+      return result.ruleId === '@typescript-eslint/semi';
+    });
+    assert.equal(semiErrors.length, 0);
+
+    // 验证黑名单中的规则已关闭，取 react/jsx-indent 进行测试
+    const errorReportedByReactPluginBlackList = messages.filter((result) => {
+      return result.ruleId === 'react/jsx-indent';
+    });
+    assert.equal(errorReportedByReactPluginBlackList.length, 0);
+  });
+
+  it('Validate eslint-config-encode/essential/typescript/vue', async () => {
+    const configPath = './essential/typescript/vue.js';
+    const filePath = path.join(__dirname, './fixtures/ts-vue.vue');
+
+    const cli = new eslint.ESLint({
+      overrideConfigFile: configPath,
+      useEslintrc: false,
+      ignore: false,
+      overrideConfig: {
+        parserOptions: {
+          project: path.join(__dirname, './fixtures/tsconfig.json'),
+        },
+      },
+    });
+
+    // 验证导出的 config 是否正常
+    const config = await cli.calculateConfigForFile(filePath);
+    assert.ok(isObject(config));
+
+    // 验证 lint 工作是否正常
+    const results = await cli.lintFiles([filePath]);
+    assert.equal(sumBy(results, 'fatalErrorCount'), 0);
+    assert.notEqual(sumBy(results, 'errorCount'), 0);
+    assert.notEqual(sumBy(results, 'warningCount'), 0);
+
+    // 验证 vue plugin 工作是否正常
+    const result = results[0];
+    const errorReportedByReactPlugin = result.messages.filter((message) => {
+      return message.ruleId && message.ruleId.indexOf('vue/') !== -1;
+    });
+    assert.notEqual(errorReportedByReactPlugin.length, 0);
+
+    // 验证黑名单中的规则已关闭
+    const errorReportedByReactPluginBlackList = result.messages.filter((message) => {
+      return message.ruleId === '@typescript-eslint/indent';
+    });
+    assert.equal(errorReportedByReactPluginBlackList.length, 0);
+  });
+
+  it('Validate eslint-config-encode/typescript/node', async () => {
+    const configPath = './typescript/node.js';
+    const filePath = path.join(__dirname, './fixtures/ts-node.ts');
+
+    const cli = new eslint.ESLint({
+      overrideConfigFile: configPath,
+      useEslintrc: false,
+      ignore: false,
+      overrideConfig: {
+        parserOptions: {
+          project: path.join(__dirname, './fixtures/tsconfig.json'),
+        },
+      },
+    });
+
+    // 验证导出的 config 是否正常
+    const config = await cli.calculateConfigForFile(filePath);
+    assert.ok(isObject(config));
+    assert.strictEqual(config.env.node, true);
+    assert.strictEqual(config.plugins.includes('node'), true);
+
+    // 验证已开启的 link 规则是否校验正常
+    const results = await cli.lintFiles([filePath]);
+    const { messages, errorCount, warningCount } = results[0];
+    const ruleIds = Array.from(messages.map((item) => item.ruleId));
+
+    assert.strictEqual(ruleIds.includes('node/prefer-promises/fs'), true);
+    assert.strictEqual(ruleIds.includes('@typescript-eslint/no-unused-vars'), true);
+    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);
+
+    // 验证已关闭的 link 规则是否校验正常，以 @typescript-eslint/explicit-function-return-type 为例
+    assert.strictEqual(ruleIds.includes('@typescript-eslint/explicit-function-return-type'), false);
+    console.log("test success!",ruleIds.includes('@typescript-eslint/explicit-function-return-type'));
+  });
+});

package/es5.js

@@ -0,0 +1,10 @@
+module.exports = {
+  extends: [
+    './rules/base/best-practices',
+    './rules/base/possible-errors',
+    './rules/base/style',
+    './rules/base/variables',
+    './rules/es5',
+  ].map(require.resolve),
+  root: true,
+};

package/essential/es5.js

@@ -0,0 +1,12 @@
+module.exports = {
+  extends: [
+    '../es5',
+    './rules/set-style-to-warn',
+    './rules/blacklist',
+  ].map(require.resolve),
+  rules: {
+    // 逗号风格 - ES5 中不加最后一个逗号
+    // @unessential
+    'comma-dangle': ['warn', 'never'],
+  },
+};

package/essential/index.js

@@ -0,0 +1,12 @@
+/**
+ * essential 级别出口文件仅将会必要的规则设置为 error 级别
+ */
+
+module.exports = {
+  extends: [
+    '../index',
+    './rules/set-style-to-warn',
+    './rules/blacklist',
+    './rules/es6-blacklist',
+  ].map(require.resolve),
+};

package/essential/react.js

@@ -0,0 +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',
+      },
+    ],
+  },
+};

package/essential/rules/blacklist.js

@@ -0,0 +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',
+  },
+};

package/essential/rules/es6-blacklist.js

@@ -0,0 +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',
+  },
+};

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

@@ -0,0 +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');

package/essential/rules/ts-blacklist.js

@@ -0,0 +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',
+  },
+};

package/essential/typescript/index.js

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

package/essential/typescript/react.js

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

package/essential/typescript/vue.js

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

package/essential/vue.js

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

package/index.js

@@ -0,0 +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,
+};

package/jsx-a11y.js

@@ -0,0 +1,5 @@
+module.exports = {
+  extends: [
+    './rules/jsx-a11y',
+  ].map(require.resolve),
+};

package/node.js

@@ -0,0 +1,6 @@
+module.exports = {
+  extends: [
+    './index',
+    './rules/node',
+  ].map(require.resolve),
+};

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@huangjunsen/eslint-config",
+  "version": "1.0.0",
+  "main": "index.js",
+  "description": "JavaScript TypeScript Node 规范",
+  "keywords": [
+    "encode",
+    "javaScript",
+    "typescript",
+    "node",
+    "lint"
+  ],
+  "author": "Huangjunsen <951434130@qq.com>",
+  "homepage": "https://github.com/Huang-junsen/js-encode-fe-spec#readme",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Huang-junsen/js-encode-fe-spec.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Huang-junsen/js-encode-fe-spec/issues"
+  },
+  "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",
+    "eslint-config-egg": "^13.1.0",
+    "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",
+    "lodash": "^4.17.21",
+    "mocha": "^10.4.0",
+    "typescript": "5.0.4",
+    "vue-eslint-parser": "^9.4.2"
+  },
+  "scripts": {
+    "lint": "eslint ./",
+    "test": "mocha ./__tests__/*.test.js --timeout 5000",
+    "print-config": "eslint --print-config ./index.js > ./print-config.json"
+  }
+}

package/react.js

@@ -0,0 +1,11 @@
+module.exports = {
+  extends: [
+    './index',
+    './rules/react',
+  ].map(require.resolve),
+  parserOptions: {
+    babelOptions: {
+      presets: ['@babel/preset-react'],
+    },
+  },
+};