团队自定义 tslint & eslint 详细规则

符合自身场景的就是最好的，但愿能给大伙带来参考

前端工程化之路-语法检查

上一篇说的详细配置文件以下

tslint.json

{
    "defaultSeverity": "error",
    "extends": [
        "tslint:recommended"
    ],
    "jsRules": {
        "no-unused-expression": true
    },
    "rules": {
        "align": [
            true,
            "parameters",
            "statements"
        ],
        "array-type": false,
        "arrow-parens": false,
        "curly": true,
        "eofline": false,
        "forin": true,
        "indent": [
            true,
            "spaces",
            4
        ],
        "interface-name": [
            true,
            "always-prefix"
        ],
        "label-position": true,
        "linebreak-style": [
            true,
            "CRLF"
        ],
        "max-classes-per-file": [
            false
        ],
        "max-file-line-count": [
            true,
            1000
        ],
        "max-line-length": [
            true,
            160
        ],
        "member-access": [
            true,
            "check-accessor"
        ],
        "member-ordering": [
            false
        ],
        "new-parens": true,
        "no-consecutive-blank-lines": true,
        "no-console": [
            true,
            "log",
            "error"
        ],
        "no-construct": true,
        "no-debugger": true,
        "no-duplicate-variable": [
            true,
            "check-parameters"
        ],
        "no-empty": [
            true,
            "allow-empty-catch"
        ],
        "no-empty-interface": false,
        "no-eval": true,
        "no-invalid-this": [
            true,
            "check-function-in-method"
        ],
        "no-shadowed-variable": [
            true,
            {
                "class": true,
                "enum": true,
                "function": true,
                "interface": false,
                "namespace": true,
                "typeAlias": false,
                "typeParameter": false
            }
        ],
        "no-switch-case-fall-through": true,
        "no-trailing-whitespace": [
            true,
            "ignore-jsdoc",
            "ignore-comments",
            "ignore-blank-lines"
        ],
        "no-unused-expression": [
            true,
            "allow-fast-null-checks"
        ],
        "no-unused-variable": [
            true,
            {
                "ignore-pattern": "^_"
            }
        ],
        "no-use-before-declare": true,
        "no-var-keyword": true,
        "object-literal-key-quotes": [
            true,
            "as-needed"
        ],
        "object-literal-sort-keys": false,
        "one-line": false,
        "one-variable-per-declaration": [
            true,
            "ignore-for-loop"
        ],
        "no-duplicate-super": true,
        "no-return-await": true,
        "prefer-const": [
            true,
            {
                "destructuring": "all"
            }
        ],
        "quotemark": [
            true,
            "single",
            "avoid-escape",
            "avoid-template"
        ],
        "radix": true,
        "semicolon": [
            true,
            "always"
        ],
        "switch-default": true,
        "trailing-comma": false,
        "triple-equals": [
            true,
            "allow-undefined-check"
        ],
        "variable-name": [
            true,
            "allow-pascal-case"
        ],
        "no-string-literal": false,
        "no-require-imports": true,
        "only-arrow-functions": [
            true,
            "allow-declarations",
            "allow-named-functions"
        ],
        "jsdoc-format": [
            true,
            "check-multiline-start"
        ],
        "switch-final-break": [
            true,
            "always"
        ]
    },
    "rulesDirectory": []
}
复制代码

----------------------------------我是分割线 咔 咔 咔 咔----------------------------------

.eslintrc.js

module.exports = {
    // 全局变量
    'env': {
        'browser': true,
        'commonjs': true,
        'es6': true,
        'node': true,
        'worker': true,
        'jquery': true
    },
    'extends': [
        "standard",
        "eslint:recommended",
        "plugin:react/recommended",
        "plugin:vue/base",
    ],
    'parserOptions': {
        "parser": "babel-eslint",
        'ecmaFeatures': {
            // 启用对实验性的 object rest/spread properties 的支持。
            'experimentalObjectRestSpread': true,
            'jsx': true,
            'globalReturn': false,
            // 启用全局 strict mode
            'impliedStrict': true
        },
        // 设置为 'script' (默认) 或 'module'（若是你的代码是 ECMAScript 模块)。
        'sourceType': 'module',
        // 设置为 3， 5 (默认)， 六、7 或 8 指定你想要使用的 ECMAScript 版本。你也能够指定为 2015（同 6），2016（同 7），或 2017（同 8）使用年份命名
        'ecmaVersion': 7
    },
    'plugins': [
    ],
    'rules': {

        /* * ------------------------------------------------ * Possible Errors * 如下规则与 JavaScript 代码中可能的错误或逻辑错误有关 * ------------------------------------------------ */

        //react 相关配置项
        "react/forbid-prop-types": [0],
        "react/jsx-filename-extension": [1, { "extensions": [".js"] }],
        "react/jsx-no-bind": [0],
        "react/jsx-indent": [2, 4],
        "react/jsx-indent-props": [2, 4],
        "react/jsx-uses-react": "error",
        "react/jsx-uses-vars": "error",
        "react/prop-types": [0],
        "react/prefer-stateless-function": [0],
        "react/jsx-wrap-multilines": [
            "error",
            {
                "declaration": "parens-new-line",
                "assignment": "parens-new-line",
                "return": "parens-new-line",
                "arrow": "parens-new-line",
                "condition": "parens-new-line",
                "logical": "parens-new-line",
                "prop": "ignore"
            }
        ],
        "jsx-a11y/no-static-element-interactions": [0],
        "jsx-a11y/no-noninteractive-element-interactions": [0],
        "jsx-a11y/click-events-have-key-events": [0],
        "jsx-a11y/anchor-is-valid": [0],

        // 禁止在常规字符串中出现模板字面量占位符语法
        'no-template-curly-in-string': 1,
        // error; for循转方向出错
        'for-direction': 2,
        // error; getter必须有返回值，而且禁止返回值为undefined, 好比 return;
        'getter-return': [2, { 'allowImplicit': false }],
        // error; 禁止在循环中出现 await
        'no-await-in-loop': 2,
        // error; 不容许使用console进行代码调试
        'no-console': 2,
        // error; 不容许使用debugger进行代码调试
        'no-debugger': 2,

        /* * ------------------------------------------------ * Best Practices * 这些规则是关于最佳实践的，帮助你避免一些问题 * ------------------------------------------------ */

        // error; 强制 getter 和 setter 在对象中成对出现
        'accessor-pairs': 2,
        // off; 对于数据相关操做函数好比reduce, map, filter等，callback必须有return
        'array-callback-return': 0,
        // error; 把var关键字当作块级做用域，防止变量提高致使的bug
        'block-scoped-var': 2,
        // error; class this
        'class-methods-use-this': 0,
        // error; 禁止或强制在计算属性中使用空格
        'computed-property-spacing': [2, 'never'],
        // error; 要求遵循大括号约定
        'curly': [2, 'all'],
        // error; switch case语句里面必定须要default分支
        'default-case': 2,
        // error; 要求点操做符和属性放在同一行
        'dot-location': [2, 'property'],
        // warn; 推荐.操做符
        'dot-notation': [1, { 'allowKeywords': false }],
        // error; === !==
        'eqeqeq': 2,
        // error; 禁止使用看起来像除法的正则表达式
        'no-div-regex': 2,
        // error; 禁止在 else 前有 return
        'no-else-return': 2,
        // error; 不容许使用空函数，除非在空函数里面给出注释说明
        'no-empty-function': 2,
        // error; if (foo === null)
        'no-eq-null': 2,
        // error; 代码中不容许使用eval
        'no-eval': 2,
        // error; 禁止修改原生对象
        'no-extend-native': [2, { 'exceptions': ['Object', 'Promise'] }],
        // error; 禁止出现不必的 bind
        'no-extra-bind': 2,
        // error; 表示小数时，禁止省略 0，好比 .5
        'no-floating-decimal': 2,
        // error; 强制类型转换
        'no-implicit-coercion': [2, { 'boolean': false, 'string': false }],
        // this关键字出如今类和类对象以外 todo
        'no-invalid-this': 1,
        // error; 禁止使用相似 eval() 的方法
        'no-implied-eval': 2,
        // error; 禁止使用 __iterator__
        'no-iterator': 2,
        // error; 禁用标签语句
        'no-labels': 2,
        // error; 禁止循环中存在函数
        'no-loop-func': 2,
        // error; 禁止使用不必的 {} 做为代码块
        'no-lone-blocks': 2,
        // error; 禁止出现连续的多个空格，除非是注释前，或对齐对象的属性、变量定义、import 等
        'no-multi-spaces': [2, {
            'ignoreEOLComments': true,
            'exceptions': { 'Property': true, 'BinaryExpression': false, 'VariableDeclarator': true, 'ImportDeclaration': true }
        }],
        // error; 禁止多行字符串
        'no-multi-str': 2,
        // error; 禁止直接 new 一个类而不赋值
        'no-new': 2,
        // error; 禁止使用 new Function，好比 const expression = new Function('a', 'b', 'return a + b');
        'no-new-func': 2,
        // error; 对于JS的原始类型好比String, Number, Boolean等，不容许使用new 操做符
        'no-new-wrappers': 2,
        // warn; 不推荐对 function 的参数进行从新赋值
        'no-param-reassign': 1,
        // error; 禁止直接使用__proto__属性，可使用getPrototypeOf替代
        'no-proto': 2,
        // error; 禁止在 return 语句中使用赋值语句
        'no-return-assign': 2,
        // error; 禁止在 return 语句中使用await
        'no-return-await': 2,
        // warn; 不推荐逗号操做符
        'no-sequences': 1,
        // error; 禁止抛出异常字面量
        'no-throw-literal': 2,
        // error; 禁用一成不变的循环条件
        'no-unmodified-loop-condition': 2,
        // error; 禁止出现未使用过的表达式
        'no-unused-expressions': 2,
        // error; 禁止没必要要的 .call() 和 .apply()
        'no-useless-call': 2,
        // error; 禁止出现不必的字符串拼接，好比 'hello' + 'world'，能够直接写成'hello world'
        'no-useless-concat': 2,
        // error; disallow redundant return statements
        'no-useless-return': 2,
        // 禁用 Alert
        'no-alert': 2,
        // 禁用 Script URL
        'no-script-url': 2,
        // error; 对数字使用 parseInt 而且老是带上类型转换的基数
        'radix': 2,
        // error; async函数里面必须有await
        'require-await': 0,
        // error; 要求全部的 var 声明出如今它们所在的做用域顶部
        'vars-on-top': 2,
        // warn; 推荐yoda表达式
        'yoda': [1, 'always'],
        // 须要约束 for-in
        'guard-for-in': 2,

        /* * ------------------------------------------------ * Variables * 这些规则与变量声明有关 * ------------------------------------------------ */

        // error; 禁止 catch 子句的参数与外层做用域中的变量同名
        'no-catch-shadow': 2,
        // error; 禁用特定的全局变量
        'no-restricted-globals': 2,
        // error; 禁止变量声明与外层做用域的变量同名
        'no-shadow': 2,
        // error; js关键字和保留字不能做为函数名或者变量名
        'no-shadow-restricted-names': 2,
        // error; 禁止label名称和var相同
        'no-label-var': 2,
        // error; 避免初始化变量值为 undefined
        'no-undef-init': 2,
        // error; 禁止将undefined当成标志符
        'no-undefined': 2,
        // error; 变量使用以前必须进行定义，函数除外
        'no-use-before-define': [2, { 'functions': false }],

        /* * ------------------------------------------------ * Stylistic Issues * 这些规则是关于风格指南的，并且是很是主观的 * ------------------------------------------------ */

        // error; 是否容许非空数组里面有多余的空格
        'array-bracket-spacing': [2, 'never'],
        // warn; 大括号风格
        'brace-style': [1, '1tbs'],
        // error; 变量命名须要以驼峰命名法，对属性字段不作限制
        'camelcase': [2, { 'properties': 'never' }],
        // error; 对象字面量项尾不能有逗号
        'comma-dangle': [2, 'never'],
        // error; 逗号风格，换行时在行首仍是行尾
        'comma-style': [2, 'last'],
        // error; 当获取当前执行环境的上下文时，强制使用一致的命名
        'consistent-this': [2, 'self', 'that'],
        // error; 函数名和执行它的括号之间禁止有空格
        'func-call-spacing': [2, 'never'],
        // error; 强制一致地使用 function 声明或表达式
        'func-style': [2, 'declaration', { 'allowArrowFunctions': true }],
        // error; 一个缩进必须用四个空格替代, switch语句里面的case 2个空格
        'indent': [2, 4, { 'SwitchCase': 2 }],
        // error; 对象字面量中冒号前面禁止有空格，后面必须有空格
        'key-spacing': [2, { 'beforeColon': false, 'afterColon': true, 'mode': 'strict' }],
        // error; 关键字先后必需要加上空格
        'keyword-spacing': [2, { 'before': true, 'after': true }],
        // off; 不限制注释位置
        'line-comment-position': 0,
        // error; 换行符
        'linebreak-style': [2, 'windows'],
        // warn; 注释前有一空行
        'lines-around-comment': [1, { 'beforeBlockComment': true, 'beforeLineComment': true }],
        // error; 强制可嵌套的块的最大深度
        'max-depth': [2, { max: 4 }],
        // warn; 单行最多容许160个字符, 对包含url的行不进行此限制
        'max-len': [1, { 'code': 160, 'ignoreUrls': true, 'ignoreComments': true, 'ignoreStrings': true, 'ignoreTemplateLiterals': true, 'ignoreRegExpLiterals': true }],
        // warn; 强制回调函数最大嵌套深度
        'max-nested-callbacks': [2, { 'max': 3 }],
        // error; 构造函数的必须以大写字母开头
        'new-cap': 2,
        // error; new 后面类必须带上括号
        'new-parens': 2,
        // error; 禁止使用 Array 构造函数
        'no-array-constructor': 2,
        // error; no continue
        'no-continue': 2,
        // error; 禁止 if 语句做为惟一语句出如今 else 语句块中
        'no-lonely-if': 2,
        // warn; 不容许多个空行
        'no-multiple-empty-lines': [1, { 'max': 1 }],
        // error; 禁止使用嵌套的三元表达式
        'no-nested-ternary': 2,
        // error; 禁用 Object 的构造函数
        'no-new-object': 2,
        // error; 强制在花括号内使用一致的换行符
        'object-curly-newline': [2, { 'multiline': true }],
        // error; 强制将对象的属性放在不一样的行上
        'object-property-newline': 2,
        // error; 变量申明必须每行一个
        'one-var': [2, 'never'],
        // warn; 变量申明必须每行一个
        'one-var-declaration-per-line': [2, 'always'],
        // error; 换行时运算符在行尾仍是行首
        'operator-linebreak': [2, 'after'],
        // warn; 句柄padding
        'padding-line-between-statements': [1, { blankLine: 'always', prev: ['const', 'let', 'var'], next: '*' }, { blankLine: 'any', prev: ['const', 'let', 'var'], next: ['const', 'let', 'var'] }],
        // error; 必须使用单引号
        'quotes': [2, 'single', { 'avoidEscape': true, 'allowTemplateLiterals': true }],
        // warn; 推荐jsdoc注释
        'require-jsdoc': [1, { 'require': { 'FunctionDeclaration': true, 'MethodDefinition': false, 'ClassDeclaration': false, 'ArrowFunctionExpression': false } }],
        // error; 结尾必须有分号
        'semi': [2, 'always'],
        // error; 一行有多个语句时，分号前面禁止有空格，分号后面必须有空格
        'semi-spacing': [2, { 'before': false, 'after': true }],
        // error; 分号必须写在行尾，禁止在行首出现
        'semi-style': [2, 'last'],
        // error; if, function 等的大括号以前必需要有空格
        'space-before-blocks': [2, 'always'],
        // error; 注释空格
        'spaced-comment': [2, 'always', { 'line': { 'markers': ['/'], 'exceptions': ['-', '+'] }, 'block': { 'markers': ['!'], 'exceptions': ['*'], 'balanced': true } }],
        // error; case 子句冒号前禁止有空格，冒号后必须有空格
        'switch-colon-spacing': [2, { 'after': true, 'before': false }],
        // 链式调用必须换行
        'newline-per-chained-call': 2,

        /* * ------------------------------------------------ * ECMAScript 6 * 这些规则只与 ES6 有关 * ------------------------------------------------ */

        // error; 箭头函数的箭头先后必须有空格
        'arrow-spacing': [2, { 'before': true, 'after': true }],
        // error; 禁止import重复模块
        'no-duplicate-imports': 2,
        // error; 要求使用 let 或 const 而不是 var
        'no-var': 2,
        // warn; 推荐使用箭头函数做为回调
        'prefer-arrow-callback': [1, { 'allowNamedFunctions': true }],
        // error; 使用const
        'prefer-const': [2, { 'destructuring': 'any', 'ignoreReadBeforeAssign': false }],
        // warn; 推荐结构赋值
        'prefer-destructuring': [1, { 'array': true, 'object': true }, { 'enforceForRenamedProperties': false }],
        // warn; 推荐rest运算符
        'prefer-rest-params': 1,
        // warn; 推荐扩展运算符
        'prefer-spread': 1,
        // error; rest 空格
        'rest-spread-spacing': [2, 'never'],
        // error; require symbol description
        'symbol-description': 2,
        // 禁止在对象中使用没必要要的计算属性
        'no-useless-computed-key': 1,
        // 禁用没必要要的构造函数
        'no-useless-constructor': 2
    }
};
复制代码