eslint-config-alloy

{ "accessor-pairs": { "name": "accessor-pairs", "value": ["error", { "setWithoutGet": true, "getWithoutSet": false }], "description": "setter 必须有对应的 getter，getter 可以没有对应的 setter", "reason": "", "badExample": "const foo = {\n eslint(accessor-pairs)\">set bar(value) {\n this.barValue = 'bar ' + value;\n },\n};", "goodExample": "const foo = {\n set bar(value) {\n this.barValue = 'bar ' + value;\n },\n get bar() {\n return this.barValue;\n },\n};\nconst bar = {\n get foo() {\n return this.fooValue;\n },\n};", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "array-callback-return": { "name": "array-callback-return", "value": "error", "description": "数组的方法除了 forEach 之外，回调函数必须有返回值", "reason": "", "badExample": "const foo = [1, 2, 3].map((num) eslint(array-callback-return)\">=> {\n console.log(num * num);\n});", "goodExample": "const foo = [1, 2, 3].map((num) => {\n return num * num;\n});", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "arrow-body-style": { "name": "arrow-body-style", "value": "off", "description": "箭头函数体必须由大括号包裹", "reason": "代码格式问题，最好由 Prettier 解决", "badExample": "", "goodExample": "", "fixable": true, "extendsBaseRule": "", "requiresTypeChecking": false }, "block-scoped-var": { "name": "block-scoped-var", "value": "off", "description": "将 var 定义的变量视为块作用域，禁止在块外使用", "reason": "已经禁止使用 var 了", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "camelcase": { "name": "camelcase", "value": "off", "description": "变量名必须是 camelCase 风格的", "reason": "很多 api 或文件名都不是 camelCase 风格的", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "capitalized-comments": { "name": "capitalized-comments", "value": "off", "description": "注释的首字母必须大写", "reason": "", "badExample": "", "goodExample": "", "fixable": true, "extendsBaseRule": "", "requiresTypeChecking": false }, "class-methods-use-this": { "name": "class-methods-use-this", "value": "off", "description": "在类的非静态方法中，必须存在对 this 的引用", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "complexity": { "name": "complexity", "value": ["error", { "max": 20 }], "description": "禁止函数的循环复杂度超过 20", "reason": "https://en.wikipedia.org/wiki/Cyclomatic_complexity", "badExample": "eslint(complexity)\">function foo() {\n if (i === 1) console.log(i);\n if (i === 2) console.log(i);\n if (i === 3) console.log(i);\n if (i === 4) console.log(i);\n if (i === 5) console.log(i);\n if (i === 6) console.log(i);\n if (i === 7) console.log(i);\n if (i === 8) console.log(i);\n if (i === 9) console.log(i);\n if (i === 10) console.log(i);\n if (i === 11) console.log(i);\n if (i === 12) console.log(i);\n if (i === 13) console.log(i);\n if (i === 14) console.log(i);\n if (i === 15) console.log(i);\n if (i === 16) console.log(i);\n if (i === 17) console.log(i);\n if (i === 18) console.log(i);\n if (i === 19) console.log(i);\n if (i === 20) console.log(i);\n}", "goodExample": "function foo() {\n if (i === 1) console.log(i);\n if (i === 2) console.log(i);\n if (i === 3) console.log(i);\n if (i === 4) console.log(i);\n if (i === 5) console.log(i);\n if (i === 6) console.log(i);\n if (i === 7) console.log(i);\n if (i === 8) console.log(i);\n if (i === 9) console.log(i);\n if (i === 10) console.log(i);\n bar(i);\n}\nfunction bar(i) {\n if (i === 11) console.log(i);\n if (i === 12) console.log(i);\n if (i === 13) console.log(i);\n if (i === 14) console.log(i);\n if (i === 15) console.log(i);\n if (i === 16) console.log(i);\n if (i === 17) console.log(i);\n if (i === 18) console.log(i);\n if (i === 19) console.log(i);\n if (i === 20) console.log(i);\n}", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "consistent-return": { "name": "consistent-return", "value": "off", "description": "禁止函数在不同分支返回不同类型的值", "reason": "缺少 TypeScript 的支持，类型判断是不准确的", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "consistent-this": { "name": "consistent-this", "value": "off", "description": "限制 this 的别名", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "constructor-super": { "name": "constructor-super", "value": "error", "description": "constructor 中必须有 super", "reason": "", "badExample": "class Foo extends Bar {\n eslint(constructor-super)\">constructor() {}\n}", "goodExample": "class Foo extends Bar {\n constructor() {\n super();\n }\n}", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "default-case": { "name": "default-case", "value": "off", "description": "switch 语句必须有 default", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "default-case-last": { "name": "default-case-last", "value": "error", "description": "switch 语句中的 default 必须在最后", "reason": "", "badExample": "switch (foo) {\n eslint(default-case-last)\">default:\n bar();\n break;\n case 1:\n baz();\n break;\n}", "goodExample": "switch (foo) {\n case 1:\n baz();\n break;\n default:\n bar();\n break;\n}", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "default-param-last": { "name": "default-param-last", "value": "off", "description": "有默认值的参数必须放在函数参数的末尾", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "dot-notation": { "name": "dot-notation", "value": "off", "description": "禁止使用 foo['bar']，必须写成 foo.bar", "reason": "当需要写一系列属性的时候，可以更统一", "badExample": "", "goodExample": "", "fixable": true, "extendsBaseRule": "", "requiresTypeChecking": false }, "eqeqeq": { "name": "eqeqeq", "value": ["error", "always"], "description": "必须使用 === 或 !==，禁止使用 == 或 !=", "reason": "", "badExample": "if (foo eslint(eqeqeq)\">== 1) {\n}\nif (bar eslint(eqeqeq)\">!= null) {\n}", "goodExample": "if (foo === 1) {\n}\nif (bar !== null) {\n}", "fixable": true, "extendsBaseRule": "", "requiresTypeChecking": false }, "for-direction": { "name": "for-direction", "value": "error", "description": "禁止方向错误的 for 循环", "reason": "", "badExample": "eslint(for-direction)\">for (let i = 0; i < 10; i--) {\n // do something\n}", "goodExample": "for (let i = 0; i < 10; i++) {\n // do something\n}", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "func-name-matching": { "name": "func-name-matching", "value": ["error", "always", { "includeCommonJSModuleExports": false }], "description": "函数赋值给变量的时候，函数名必须与变量名一致", "reason": "", "badExample": "const eslint(func-name-matching)\">foo = function bar() {};", "goodExample": "const foo = function () {};\nconst bar = function bar() {};", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "func-names": { "name": "func-names", "value": "off", "description": "函数必须有名字", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "func-style": { "name": "func-style", "value": "off", "description": "必须只使用函数声明或只使用函数表达式", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "getter-return": { "name": "getter-return", "value": "error", "description": "getter 必须有返回值，并且禁止返回空", "reason": "", "badExample": "const user = {\n eslint(getter-return)\">get name() {\n // do something\n },\n};\nclass User {\n get name() {\n eslint(getter-return)\">return;\n }\n}", "goodExample": "const user = {\n get name() {\n return 'Alex';\n },\n};\nclass User {\n get name() {\n return this.name;\n }\n}", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "grouped-accessor-pairs": { "name": "grouped-accessor-pairs", "value": "error", "description": "setter 和 getter 必须写在一起", "reason": "", "badExample": "const foo = {\n set bar(value) {\n this.barValue = 'bar ' + value;\n },\n baz: 1,\n eslint(grouped-accessor-pairs)\">get bar() {\n return this.barValue;\n },\n};", "goodExample": "const foo = {\n set bar(value) {\n this.barValue = 'bar ' + value;\n },\n get bar() {\n return this.barValue;\n },\n baz: 1,\n};", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "guard-for-in": { "name": "guard-for-in", "value": "error", "description": "for in 内部必须有 hasOwnProperty", "reason": "", "badExample": "eslint(guard-for-in)\">for (key in foo) {\n doSomething(key);\n}", "goodExample": "for (key in foo) {\n if (Object.prototype.hasOwnProperty.call(foo, key)) {\n doSomething(key);\n }\n}", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "id-denylist": { "name": "id-denylist", "value": "off", "description": "禁止使用指定的标识符", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "id-length": { "name": "id-length", "value": "off", "description": "限制变量名长度", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "id-match": { "name": "id-match", "value": "off", "description": "限制变量名必须匹配指定的正则表达式", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "init-declarations": { "name": "init-declarations", "value": "off", "description": "变量必须在定义的时候赋值", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "line-comment-position": { "name": "line-comment-position", "value": "off", "description": "单行注释必须写在上一行", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "lines-between-class-members": { "name": "lines-between-class-members", "value": "off", "description": "类的成员之间是否需要空行", "reason": "有时为了紧凑需要挨在一起，有时为了可读性需要空一行", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "logical-assignment-operators": { "name": "logical-assignment-operators", "value": "off", "description": "使用 a ||= b 替代 a = a || b", "reason": "", "badExample": "", "goodExample": "", "fixable": true, "extendsBaseRule": "", "requiresTypeChecking": false }, "max-classes-per-file": { "name": "max-classes-per-file", "value": "off", "description": "限制一个文件中类的数量", "reason": "", "badExample": "", "goodExample": "", "fixable": false, "extendsBaseRule": "", "requiresTypeChecking": false }, "max-depth": { "name": "max-depth", "value": ["error", 5], "description": "代码块嵌套的深度禁止超过 5 层", "reason": "", "badExample": "function foo() {\n if (true) {\n if (true) {\n if (true) {\n if (true) {\n if (true) {\n eslint(max-depth)\">if (true) {\n }\n }\n }\n }\n }\n }\n}",