@huangjunsen/eslint-config 1.0.0

package/rules/base/best-practices.js

@@ -0,0 +1,284 @@
+module.exports = {
+  rules: {
+    // 强制 getter 和 setter 在对象中成对出现
+    'accessor-pairs': 'off',
+
+    // 某些数组方法的回调函数中必须包含 return 语句
+    'array-callback-return': ['error', { allowImplicit: true }],
+
+    // 把 var 语句看作是在块级作用域范围之内，不能在块外使用
+    'block-scoped-var': 'error',
+
+    // 强制类的方法使用 this
+    'class-methods-use-this': [
+      'off',
+      {
+        exceptMethods: [],
+      },
+    ],
+
+    // 设置圈复杂度最大值
+    // @reason IDE 插件会把大段代码标红，影响编码体验，此类问题适合做后置检查
+    complexity: ['off', 10],
+
+    // 要求 return 语句要么总是指定返回的值，要么不指定
+    'consistent-return': 'off',
+
+    // 多行语句必须用大括号包裹，单行语句推荐用大括号包裹
+    curly: ['error', 'multi-line'],
+
+    // switch 语句需要始终包含 default 分支
+    'default-case': ['warn', { commentPattern: '^no default$' }],
+
+    // 统一在点号之前换行
+    // @unessential
+    'dot-location': ['error', 'property'],
+
+    // 优先使用 . 访问对象的属性
+    'dot-notation': ['error', { allowKeywords: true }],
+
+    // 使用严格相等运算符
+    eqeqeq: ['warn', 'always', { null: 'ignore' }],
+
+    // for-in 循环中需要对 key 进行验证
+    'guard-for-in': 'warn',
+
+    // enforce a maximum number of classes per file
+    'max-classes-per-file': 'off',
+
+    // 禁止使用 alert
+    'no-alert': 'warn',
+
+    // 禁止使用 arguments.caller 和 arguments.callee
+    'no-caller': 'error',
+
+    // case 或 default 字句出现词法声明时，必须用块包裹
+    'no-case-declarations': 'error',
+
+    // 禁止使用看起来像除法的正则表达式
+    'no-div-regex': 'off',
+
+    // 如果一个 if 语句的结果总是返回一个 return 语句，那么最后的 else 是不必要的
+    // @reason 很多人习惯写 else return
+    'no-else-return': 'off',
+
+    // 不要出现空函数
+    'no-empty-function': [
+      'error',
+      {
+        allow: ['arrowFunctions', 'functions', 'methods'],
+      },
+    ],
+
+    // 不要在解构中出现空模式，即 {} 或 []
+    'no-empty-pattern': 'error',
+
+    // 与 null 的比较必须使用严格等于操作符
+    'no-eq-null': 'off',
+
+    // 禁止使用 eval
+    // @unessential 部分场景必须使用 eval
+    'no-eval': 'error',
+
+    // 禁止扩展原生对象
+    'no-extend-native': 'error',
+
+    // 禁止不必要的 .bind() 调用
+    'no-extra-bind': 'error',
+
+    // 禁止不必要的 label
+    'no-extra-label': 'error',
+
+    // 不要让 case 语句落空
+    'no-fallthrough': 'error',
+
+    // 不要省略小数点前或小数点后的 0
+    'no-floating-decimal': 'error',
+
+    // 禁止对原生对象或只读的全局对象进行赋值
+    'no-global-assign': ['error', { exceptions: [] }],
+
+    // 禁止使用较短的符号实现类型转换
+    'no-implicit-coercion': [
+      'off',
+      {
+        boolean: false,
+        number: true,
+        string: true,
+        allow: [],
+      },
+    ],
+
+    // 禁止在全局范围使用变量和函数声明
+    // @reason 这条在 "parserOptions": { "sourceType": "module" } 下不起作用
+    'no-implicit-globals': 'off',
+
+    // 禁止使用类 eval 的方法，如 setTimeout 传入字符串
+    // @unessential
+    'no-implied-eval': 'error',
+
+    // 禁止在 class 外使用 this
+    'no-invalid-this': 'off',
+
+    // 禁止使用 __iterator__ 属性
+    'no-iterator': 'error',
+
+    // 不要使用 label
+    'no-labels': ['warn', { allowLoop: false, allowSwitch: false }],
+
+    // 禁止使用不必要的代码块
+    'no-lone-blocks': 'error',
+
+    // 禁止在循环中的函数内出现外部作用域中定义且会发生变化的变量，以防止闭包副作用
+    'no-loop-func': 'error',
+
+    // 禁用魔术数字
+    'no-magic-numbers': [
+      'off',
+      {
+        ignore: [],
+        ignoreArrayIndexes: true,
+        enforceConst: true,
+        detectObjects: false,
+      },
+    ],
+
+    // 禁止出现多个连续空格
+    // @unessential
+    'no-multi-spaces': [
+      'error',
+      {
+        ignoreEOLComments: false,
+      },
+    ],
+
+    // 禁止使用多行字符串
+    'no-multi-str': 'error',
+
+    // 禁止单独 new 一个构造函数而不用于赋值或比较
+    'no-new': 'error',
+
+    // 不要使用 Function 构造函数创建函数
+    'no-new-func': 'error',
+
+    // 不要使用 new Number/String/Boolean
+    'no-new-wrappers': 'error',
+
+    // 禁用八进制字面量
+    'no-octal': 'error',
+
+    // 禁止在字符串字面量中使用八进制转义序列，如 var foo = 'Copyright \251';
+    'no-octal-escape': 'error',
+
+    // 不要修改函数参数
+    'no-param-reassign': [
+      'warn',
+      {
+        props: true,
+        ignorePropertyModificationsFor: [
+          'acc', // for reduce accumulators
+          'e', // for e.returnvalue
+          'ctx', // for Koa routing
+          'draft', // for immer
+          'req', // for Express requests
+          'request', // for Express requests
+          'res', // for Express responses
+          'response', // for Express responses
+          '$scope', // for Angular 1 scopes
+        ],
+      },
+    ],
+
+    // 禁止使用 __proto__ 属性
+    'no-proto': 'error',
+
+    // 不要重复声明变量和函数
+    'no-redeclare': 'error',
+
+    // 禁止使用某些对象的某些属性
+    'no-restricted-properties': 'off',
+
+    // 禁止在 return 语句中赋值
+    'no-return-assign': ['error', 'always'],
+
+    // 禁止不必要的 return await
+    'no-return-await': 'off',
+
+    // 禁止使用 javascript:url，如 location.href = 'javascript:void(0)';
+    // @unessential
+    'no-script-url': 'error',
+
+    // 禁止自我赋值
+    'no-self-assign': 'error',
+
+    // 禁止自我比较
+    'no-self-compare': 'error',
+
+    // 禁止使用逗号操作符，除非用于 for 循环条件或明确用小括号包裹
+    'no-sequences': 'error',
+
+    // 不要抛出字面量异常
+    'no-throw-literal': 'warn',
+
+    // 禁用不变的循环条件
+    'no-unmodified-loop-condition': 'off',
+
+    // 禁止出现未使用的表达式
+    'no-unused-expressions': [
+      'error',
+      {
+        allowShortCircuit: true,
+        allowTernary: true,
+        allowTaggedTemplates: true,
+      },
+    ],
+
+    // 禁止未使用的标签
+    'no-unused-labels': 'error',
+
+    // 禁用不必要的 .call() 和 .apply()
+    'no-useless-call': 'off',
+
+    // 禁用不必要的 catch
+    'no-useless-catch': 'error',
+
+    // 禁止不必要的字符串拼接
+    'no-useless-concat': 'error',
+
+    // 禁止不必要的转义字符
+    'no-useless-escape': 'error',
+
+    // 禁止多余的 return; 语句
+    'no-useless-return': 'error',
+
+    // 不要使用 void 运算符
+    'no-void': 'error',
+
+    // 禁止在注释中使用特定的警告术语
+    'no-warning-comments': ['off', { terms: ['todo', 'fixme'], location: 'start' }],
+
+    // 禁止使用 with
+    'no-with': 'error',
+
+    // Promise 的 reject 需要传入 Error 对象
+    'prefer-promise-reject-errors': ['warn', { allowEmptyReject: true }],
+
+    // 使用 parseInt() 方法时总是带上基数
+    radix: 'warn',
+
+    // 禁止使用不带 await 表达式的 async 函数
+    'require-await': 'off',
+
+    // 强制正则使用 u 参数
+    'require-unicode-regexp': 'off',
+
+    // 要求所有的 var 声明出现在它们所在的作用域顶部
+    'vars-on-top': 'off',
+
+    // 将立即执行函数表达式（IIFE）用小括号包裹
+    'wrap-iife': ['error', 'any', { functionPrototypeMethods: false }],
+
+    // 使用 color === 'red' 而不是 'red' === color
+    yoda: 'warn',
+  },
+};

package/rules/base/es6.js

@@ -0,0 +1,168 @@
+module.exports = {
+  rules: {
+    // 箭头函数-函数体风格
+    // @reason 允许灵活使用
+    'arrow-body-style': [
+      'off',
+      'as-needed',
+      {
+        requireReturnForObjectLiteral: false,
+      },
+    ],
+
+    // 箭头函数-函数参数始终加上小括号
+    // @reason 同 prettier 默认配置值一致：https://prettier.io/docs/en/options.html#arrow-function-parentheses
+    'arrow-parens': ['warn', 'always'],
+
+    // 箭头函数的箭头前后各留一个空格
+    // @unessential
+    'arrow-spacing': ['error', { before: true, after: true }],
+
+    // 子类的 constructor 中必须使用 super，非子类的 constructor 中不能使用 super
+    'constructor-super': 'error',
+
+    // generator 函数的 * 号前面无空格，后面有一个空格
+    // @unessential
+    'generator-star-spacing': ['error', { before: false, after: true }],
+
+    // 禁止对类声明变量重新赋值
+    'no-class-assign': 'error',
+
+    // 避免箭头函数与比较操作符产生混淆
+    // @unessential
+    'no-confusing-arrow': 'error',
+
+    // 禁止修改 const 声明的变量
+    'no-const-assign': 'error',
+
+    // 避免重复的类成员命名
+    'no-dupe-class-members': 'error',
+
+    // 不要用多个 import 引入同一模块
+    // @reason replacedBy import/no-duplicates
+    'no-duplicate-imports': 'off',
+
+    // 禁止使用 new Symbol
+    'no-new-symbol': 'error',
+
+    // 禁止特定的 import
+    'no-restricted-imports': [
+      'off',
+      {
+        paths: [],
+        patterns: [],
+      },
+    ],
+
+    // 在 constructor 中，禁止在调用 super() 前使用 this 或 super 关键字
+    'no-this-before-super': 'error',
+
+    // 对象的属性名不要使用无必要的计算属性
+    'no-useless-computed-key': 'error',
+
+    // 避免不必要的 constructor
+    'no-useless-constructor': 'error',
+
+    // 禁止在解构/import/export时进行无用的重命名
+    'no-useless-rename': [
+      'error',
+      {
+        ignoreDestructuring: false,
+        ignoreImport: false,
+        ignoreExport: false,
+      },
+    ],
+
+    // 使用 const 或 let 声明变量，不要使用 var
+    // @unessential
+    'no-var': 'error',
+
+    // 使用对象属性和方法的简写语法
+    // @unessential
+    'object-shorthand': [
+      'error',
+      'always',
+      {
+        ignoreConstructors: false,
+        avoidQuotes: true,
+      },
+    ],
+
+    // 回调函数使用箭头函数而不是匿名函数
+    // @unessential
+    'prefer-arrow-callback': [
+      'error',
+      {
+        allowNamedFunctions: false,
+        allowUnboundThis: true,
+      },
+    ],
+
+    // 优先使用 const，只有当变量会被重新赋值时才使用 let
+    // @unessential
+    'prefer-const': [
+      'error',
+      {
+        destructuring: 'any',
+        ignoreReadBeforeAssign: true,
+      },
+    ],
+
+    // 使用对象和数组的解构
+    'prefer-destructuring': [
+      'warn',
+      {
+        VariableDeclarator: {
+          array: false,
+          object: true,
+        },
+        AssignmentExpression: {
+          array: false,
+          object: false,
+        },
+      },
+      {
+        enforceForRenamedProperties: false,
+      },
+    ],
+
+    // 禁止使用 parseInt() 进行二、八、十六禁止转换
+    'prefer-numeric-literals': 'off',
+
+    // 使用 rest 操作符替代 arguments 对象
+    'prefer-rest-params': 'warn',
+
+    // 使用扩展运算符 ... 替代 apply()
+    'prefer-spread': 'warn',
+
+    // 使用模板字符串替代字符串拼接
+    'prefer-template': 'warn',
+
+    // generator 函数内必须有 yield 语句
+    'require-yield': 'error',
+
+    // 剩余和扩展操作符与操作对象间不应有空格
+    'rest-spread-spacing': ['error', 'never'],
+
+    // 为 import 排序
+    'sort-imports': [
+      'off',
+      {
+        ignoreCase: false,
+        ignoreMemberSort: false,
+        memberSyntaxSortOrder: ['none', 'all', 'multiple', 'single'],
+      },
+    ],
+
+    // 创建 Symbol 时必须传入参数
+    'symbol-description': 'warn',
+
+    // 模板字符串中的大括号内部两侧无空格
+    // @unessential
+    'template-curly-spacing': 'warn',
+
+    // yield* 表达式的 * 号前面无空格，后面有一个空格
+    // @unessential
+    'yield-star-spacing': ['error', 'after'],
+  },
+};

package/rules/base/possible-errors.js

@@ -0,0 +1,126 @@
+module.exports = {
+  rules: {
+    // for 循环中的计数器应朝着正确方向移动
+    'for-direction': 'error',
+
+    // getter 需要有返回值
+    'getter-return': ['error', { allowImplicit: true }],
+
+    // 不要使用 async 函数作为 Promise 的 executor
+    'no-async-promise-executor': 'error',
+
+    // 不要在循环中使用 await，应使用 Promise.all()
+    'no-await-in-loop': 'warn',
+
+    // 不要与负零进行比较
+    'no-compare-neg-zero': 'error',
+
+    // 不要在条件表达式中使用赋值语句
+    'no-cond-assign': ['error', 'always'],
+
+    // 生产环境禁止使用 console
+    'no-console': 'warn',
+
+    // 不要在条件表达式中使用常量
+    'no-constant-condition': 'warn',
+
+    // 禁止在正则中使用 ctrl 键的 ASCII 码
+    'no-control-regex': 'off',
+
+    // 禁止使用 debugger
+    'no-debugger': 'error',
+
+    // 函数的参数列表中禁止出现重复命名的参数
+    'no-dupe-args': 'error',
+
+    // 对象中禁止出现重复命名的 key
+    'no-dupe-keys': 'error',
+
+    // switch 语句中禁止出现重复的 case
+    'no-duplicate-case': 'error',
+
+    // 不要出现空代码块
+    'no-empty': 'error',
+
+    // 禁止在正则中使用空字符集 []，这不能匹配任何字符，可能是 typo
+    'no-empty-character-class': 'error',
+
+    // 禁止对 catch 的入参重新赋值
+    'no-ex-assign': 'error',
+
+    // 避免不必要的布尔类型转换
+    'no-extra-boolean-cast': 'error',
+
+    // 禁止不必要的小括号
+    'no-extra-parens': [
+      'off',
+      'all',
+      {
+        conditionalAssign: true,
+        nestedBinaryExpressions: false,
+        returnAssign: false,
+        ignoreJSX: 'all', // delegate to eslint-plugin-react
+        enforceForArrowConditionals: false,
+      },
+    ],
+
+    // 禁止不必要的分号
+    'no-extra-semi': 'error',
+
+    // 不要对函数声明重新赋值
+    'no-func-assign': 'error',
+
+    // 不要在块中使用函数声明
+    'no-inner-declarations': 'error',
+
+    // 禁止在 RegExp 构造函数中使用无效的正则表达式
+    'no-invalid-regexp': 'error',
+
+    // 禁止不规则的空白符
+    'no-irregular-whitespace': 'error',
+
+    // 禁止在正则的字符集语法 [] 中使用由多个字符点构成的字符
+    'no-misleading-character-class': 'error',
+
+    // 禁止将全局对象 Math、JSON、Reflect 当作函数进行调用
+    'no-obj-calls': 'error',
+
+    // 不要直接在对象上调用 Object.prototypes 上的方法
+    // @unessential
+    'no-prototype-builtins': 'error',
+
+    // 禁止在正则表达式中出现多个连续空格
+    'no-regex-spaces': 'error',
+
+    // 禁用稀疏数组，如 var items = [,,];
+    'no-sparse-arrays': 'error',
+
+    // 不要在普通字符串中出现模板字符串占位语法，如 "Hello ${name}!"，旨在防错写。
+    // 但不排除有时普通字符串内容就是这样，因此这条开为 warn 级别
+    'no-template-curly-in-string': 'warn',
+
+    // 避免令人困惑的多行表达式，多是由不加分号导致
+    'no-unexpected-multiline': 'error',
+
+    // 不要在 return 等语句之后出现不可达的代码
+    'no-unreachable': 'error',
+
+    // 禁止在 finally 中出现控制流语句，如 return, throw, break 或 continue
+    'no-unsafe-finally': 'error',
+
+    // 禁止对关系运算符左边的运算元使用否定操作符，包括 in 和 instanceof
+    'no-unsafe-negation': 'error',
+
+    // 避免因使用 await 或 yield 导致的竞争性赋值
+    'require-atomic-updates': 'warn',
+
+    // 使用 Number.isNaN()，而不是直接与 NaN 进行比较
+    'use-isnan': 'error',
+
+    // 使用有效的 JSDoc 注释
+    'valid-jsdoc': 'off',
+
+    // 同 typeof 表达式结果进行比较的值必须是有效的字符串，即 'undefined', 'object', 'boolean', 'number', 'string', 'function' 或 'symbol'
+    'valid-typeof': ['error', { requireStringLiterals: true }],
+  },
+};

package/rules/base/strict.js

@@ -0,0 +1,6 @@
+module.exports = {
+  rules: {
+    // 不限制严格模式的使用
+    strict: 'off',
+  },
+};