前端多人开发,统一代码规范很重要。ESLint 配置复杂且繁多。记录一下团队规范配置,供大家参考。
{
"breadcrumbs.enabled": false,
"editor.fontFamily": "Menlo, Consolas, 'Courier New', monospace",
"editor.formatOnSave": true,
"editor.minimap.enabled": false,
"editor.linkedEditing": true,
"editor.tabSize": 2,
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true
},
"eslint.options": {
// 环境定义了预定义的全局变量
"env": {
"browser": true,
"node": true,
"commonjs": true,
"es6": true
},
"ecmaVersion": 6,
"extensions": [
".js",
".vue"
],
/**
"off" 或 0 - 关闭规则
"warn" 或 1 - 开启规则,使用警告级别的错误:warn (不会导致程序退出)
"error" 或 2 - 关闭规则,使用错误级别的错误:error(当被触发的时候,程序会退出)
*/
"rules": {
// 禁用alert
"no-alert": 1,
// 禁止给类赋值
"no-class-assign": 2,
// 禁止使用console
"no-console": 1,
// 禁止修改 const 声明的变量
"no-const-assign": 2,
// 禁止在条件中使用常量表达式
"no-constant-condition": 1,
// 建议不使用 continue 语句
"no-continue": 0,
// 禁止使用debugger
"no-debugger": 1,
// 在创建对象字面量时不允许键重复 {a:1,a:1}
"no-dupe-keys": 2,
// 函数参数不能重复
"no-dupe-args": 2,
// switch中的case标签不能重复
"no-duplicate-case": 2,
// 如果if语句里面有return,后面不能跟else语句
"no-else-return": 1,
// 块语句中的内容不能为空
"no-empty": 1,
// 正则表达式中的[]内容不能为空
"no-empty-character-class": 2,
//禁止使用空label
"no-empty-label": 0,
// 禁止对null使用==或!=运算符
"no-eq-null": 1,
// 禁用eval()
"no-eval": 1,
// 禁止给catch语句中的异常参数赋值
"no-ex-assign": 1,
// 禁止不必要的函数绑定
"no-extra-bind": 1,
// 禁止不必要的bool转换
"no-extra-boolean-cast": 2,
// 禁止非必要的括号
"no-extra-parens": 1,
//禁止非必要的冒号
"no-extra-semi": 1,
// 禁止switch穿透
"no-fallthrough": 0,
// 禁止省略浮点数中的0 .5 3.
"no-floating-decimal": 1,
// 禁止重复的函数声明
"no-func-assign": 1,
// 禁止隐式转换
"no-implicit-coercion": 1,
// 禁止使用隐式eval
"no-implied-eval": 2,
// 禁止行内备注
"no-inline-comments": 0,
// 禁止在块语句中使用声明(变量或函数)
"no-inner-declarations": [
1,
"functions"
],
// 禁止无效的正则表达式
"no-invalid-regexp": 1,
// 禁止无效的this,只能用在构造器,类,对象字面量
"no-invalid-this": 1,
// 不能有不规则的空格
"no-irregular-whitespace": 1,
// 禁止使用__iterator__ 属性
"no-iterator": 1,
// label名不能与var声明的变量名相同
"no-label-var": 1,
// 禁止标签声明
"no-labels": 1,
// 禁止不必要的嵌套块
"no-lone-blocks": 1,
// 禁止else语句内只有if语句
"no-lonely-if": 0,
// 禁止在循环中使用函数(如果没有引用外部变量不形成闭包就可以)
"no-loop-func": 1,
// 声明时不能混用声明类型
"no-mixed-requires": [
0,
false
],
// 禁止混用tab和空格
"no-mixed-spaces-and-tabs": [
2,
false
],
// 换行风格
"linebreak-style": [
0,
"windows"
],
// 不能用多余的空格
"no-multi-spaces": 1,
// 字符串不能用\换行
"no-multi-str": 1,
// 空行最多不能超过2行
"no-multiple-empty-lines": [
1,
{
"max": 2
}
],
// 不能重写native对象
"no-native-reassign": 1,
// in 操作符的左边不能有!
"no-negated-in-lhs": 1,
// 禁止使用嵌套的三目运算
"no-nested-ternary": 1,
// 禁止在使用new构造一个实例后不赋值
"no-new": 1,
// 禁止使用new Function
"no-new-func": 1,
// 禁止使用new Object()
"no-new-object": 1,
// 禁止使用new require
"no-new-require": 1,
// 禁止使用new创建包装实例,new String new Boolean new Number
"no-new-wrappers": 1,
// 不能调用内置的全局对象,比如Math() JSON()
"no-obj-calls": 1,
// 禁止使用八进制数字
"no-octal": 1,
// 禁止使用八进制转义序列
"no-octal-escape": 1,
//禁止给参数重新赋值
"no-param-reassign": 1,
//node中不能使用__dirname或__filename做路径拼接
"no-path-concat": 0,
//禁止使用++,--
"no-plusplus": 0,
//禁止使用process.env
"no-process-env": 0,
//禁止使用process.exit()
"no-process-exit": 0,
//禁止使用__proto__属性
"no-proto": 1,
//禁止重复声明变量
"no-redeclare": 1,
//禁止在正则表达式字面量中使用多个空格 /foo bar/
"no-regex-spaces": 1,
//如果禁用了指定模块,使用就会报错
"no-restricted-modules": 0,
//return 语句中不能有赋值表达式
"no-return-assign": 1,
//禁止使用javascript:void(0)
"no-script-url": 0,
//不能比较自身
"no-self-compare": 1,
//禁止使用逗号运算符
"no-sequences": 0,
//外部作用域中的变量不能与它所包含的作用域中的变量或参数同名
"no-shadow": 1,
//严格模式中规定的限制标识符不能作为声明时的变量名使用
"no-shadow-restricted-names": 1,
//函数调用时 函数名与()之间不能有空格
"no-spaced-func": 1,
//禁止稀疏数组, [1,,2]
"no-sparse-arrays": 2,
//nodejs 禁止同步方法
"no-sync": 0,
//禁止使用三目运算符
"no-ternary": 0,
//一行结束后面不要有空格
"no-trailing-spaces": 0,
//在调用super()之前不能使用this或super
"no-this-before-super": 0,
//禁止抛出字面量错误 throw "error";
"no-throw-literal": 2,
//不能有未定义的变量
"no-undef": 1,
//变量初始化时不能直接给它赋值为undefined
"no-undef-init": 2,
//不能使用undefined
"no-undefined": 1,
//避免多行表达式
"no-unexpected-multiline": 2,
//标识符不能以_开头或结尾
"no-underscore-dangle": 0,
//禁止不必要的嵌套 var isYes = answer === 1 ? true : false;
"no-unneeded-ternary": 1,
//不能有无法执行的代码
"no-unreachable": 1,
//禁止无用的表达式
"no-unused-expressions": 0,
//不能有声明后未被使用的变量或参数
"no-unused-vars": [
1,
{
"vars": "all",
"args": "after-used"
}
],
//未定义前不能使用
"no-use-before-define": 0,
//禁止不必要的call和apply
"no-useless-call": 1,
//禁用void操作符
"no-void": 2,
//禁用var,用let和const代替
"no-var": 0,
//不能有警告备注
"no-warning-comments": [
1,
{
"terms": [
"todo",
"fixme",
"xxx"
],
"location": "start"
}
],
//禁用with
"no-with": 2,
//是否允许非空数组里面有多余的空格
"array-bracket-spacing": [
1,
"never"
],
//箭头函数用小括号括起来
"arrow-parens": 0,
// =>的前/后空格
"arrow-spacing": [
1,
{
"before": true,
"after": true
}
],
//在对象中使用getter/setter
"accessor-pairs": 0,
//块语句中使用var
"block-scoped-var": 0,
//大括号风格
"brace-style": [
1,
"1tbs"
],
//避免多次调用回调什么的
"callback-return": 1,
//强制驼峰法命名
"camelcase": 0,
"comma-dangle": "off",
//逗号前后的空格
"comma-spacing": 2,
//逗号风格,换行时在行首还是行尾
"comma-style": [
0,
"last"
],
//循环复杂度
"complexity": [
0,
11
],
//是否允许计算后的键名什么的
"computed-property-spacing": [
0,
"never"
],
//return 后面是否允许省略
"consistent-return": 0,
//this别名
"consistent-this": [
0,
"that"
],
//非派生类不能调用super,派生类必须调用super
"constructor-super": 0,
//必须使用 if(){} 中的{}
"curly": [
1,
"all"
],
//switch语句最后必须有default
"default-case": 1,
//对象访问符的位置,换行的时候在行首还是行尾
"dot-location": 0,
//避免不必要的方括号
"dot-notation": [
0,
{
"allowKeywords": true
}
],
//文件以单一的换行符结束
"eol-last": 0,
//必须使用全等
"eqeqeq": 1,
//函数表达式必须有名字
"func-names": 0,
//函数风格,规定只能使用函数声明/函数表达式
"func-style": [
0,
"declaration"
],
//生成器函数*的前后空格
"generator-star-spacing": 0,
//for in循环要用if语句过滤
"guard-for-in": "error",
//nodejs 处理错误
"handle-callback-err": 0,
//变量名长度
"id-length": 0,
//缩进风格
"indent": [
0,
4
],
//声明时必须赋初值
"init-declarations": 0,
//对象字面量中冒号的前后空格
"key-spacing": [
1,
{
"beforeColon": false,
"afterColon": true
}
],
// 要求在块级注释之前有空一行 行前/行后备注
"lines-around-comment": 0,
//嵌套块深度
"max-depth": [
1,
4
],
// 单行最大长度
"max-len": [
1,
120
],
//回调嵌套深度
"max-nested-callbacks": [
0,
2
],
//函数最多只能有5个参数
"max-params": [
1,
5
],
//函数内最多有几个声明
"max-statements": [
0,
10
],
//函数名首行大写必须使用new方式调用,首行小写必须用不带new方式调用
"new-cap": 0,
//new时必须加小括号
"new-parens": 2,
//变量声明后是否需要空一行
"newline-after-var": 0,
//大括号内是否允许不必要的空格
"object-curly-spacing": [
0,
"never"
],
//强制对象字面量缩写语法
"object-shorthand": 0,
//连续声明
"one-var": 0,
//赋值运算符 += -=什么的
"operator-assignment": [
0,
"always"
],
//换行时运算符在行尾还是行首
"operator-linebreak": [
1,
"after",
{
"overrides": {
"?": "before",
":": "before"
}
}
],
//块语句内行首行尾是否要空行
"padded-blocks": 0,
//首选const
"prefer-const": [
"error",
{
"destructuring": "any",
"ignoreReadBeforeAssign": false
}
],
//首选展开运算
"prefer-spread": 0,
//首选Reflect的方法
"prefer-reflect": 0,
//引号类型 `` "" ""
"quotes": [
1,
"single"
],
//对象字面量中的属性名是否强制双引号
"quote-props": [
0,
"always"
],
//parseInt必须指定第二个参数
"radix": 1,
//命名检测
"id-match": 0,
//生成器函数必须有yield
"require-yield": 0,
//分号前后空格
"semi-spacing": [
0,
{
"before": false,
"after": true
}
],
//变量声明时排序
"sort-vars": 0,
//关键字后面是否要空一格
"space-after-keywords": [
0,
"always"
],
//不以新行开始的块{前面要不要有空格
"space-before-blocks": [
0,
"always"
],
//函数定义时括号前面要不要有空格
"space-before-function-paren": [
0,
"always"
],
//小括号里面要不要有空格
"space-in-parens": [
0,
"never"
],
//中缀操作符周围要不要有空格
"space-infix-ops": 0,
//return throw case后面要不要加空格
"space-return-throw-case": 0,
//一元运算符的前/后要不要加空格
"space-unary-ops": [
0,
{
"words": true,
"nonwords": false
}
],
//注释风格要不要有空格什么的
"spaced-comment": 0,
//使用严格模式
"strict": 0,
//禁止比较时使用NaN,只能用isNaN()
"use-isnan": 2,
//jsdoc规则
"valid-jsdoc": 0,
//必须使用合法的typeof的值
"valid-typeof": 1,
//var必须放在作用域顶部
"vars-on-top": 1,
//立即执行函数表达式的小括号风格
"wrap-iife": [
1,
"inside"
],
//正则表达式字面量用小括号包起来
"wrap-regex": 0,
//禁止尤达条件
"yoda": [
2,
"never"
],
// vue 组件未被使用
"vue/no-unused-components": 1,
// switch case 中存在变量声明,需要用大括号
"no-case-declarations": 1,
// vue dom 中v-if 和v-for 不能同时存在
"vue/no-use-v-if-with-v-for": 1,
// ============================================================================================================
// 禁止条件表达式中出现赋值操作符
"no-cond-assign": 2,
// 禁用魔鬼数字,使用常量代替
"no-magic-numbers": [
2,
{
"ignore": [
0,
-1,
1
]
}
],
// 关键字前后使用一致空格
"keyword-spacing": 2,
// 强制最大行数
"max-lines": [
1,
1000
],
// 禁止直接使用 Object.prototypes 的内置属性
"no-prototype-builtins": 2,
// 组件中的属性默认值是否检查
"vue/require-default-prop": "off",
"vue/html-self-closing": "off",
"vue/attributes-order": "off",
}
},
"eslint.validate": [
"javascript",
"javascriptreact",
"vue",
"html"
],
"git.autofetch": true,
"git.enableSmartCommit": true,
"html.format.extraLiners": "",
"html.format.indentInnerHtml": true,
"html.format.wrapLineLength": 0,
"javascript.validate.enable": false,
"javascript.format.insertSpaceAfterFunctionKeywordForAnonymousFunctions": false,
"javascript.format.insertSpaceBeforeFunctionParenthesis": true,
"javascript.updateImportsOnFileMove.enabled": "always",
"prettier.singleQuote": true,
"prettier.semi": true,
"prettier.trailingComma": "none",
"vetur.ignoreProjectWarning": true,
"vetur.format.defaultFormatter.html": "js-beautify-html",
"[javascript]": {
"editor.defaultFormatter": "vscode.typescript-language-features"
},
"[jsonc]": {
"editor.defaultFormatter": "vscode.json-language-features"
},
"[json]": {
"editor.defaultFormatter": "vscode.json-language-features"
},
"[vue]": {
"editor.defaultFormatter": "octref.vetur"
},
"[html]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[javascriptreact]": {
"editor.defaultFormatter": "vscode.typescript-language-features"
},
"workbench.startupEditor": "newUntitledFile",
// "files.autoSave": "onFocusChange",
"vetur.format.defaultFormatter.js": "vscode-typescript",
"security.workspace.trust.untrustedFiles": "open",
"editor.rulers": [
120
],
"vetur.format.defaultFormatterOptions": {
"prettyhtml": {
"printWidth": 100,
"singleQuote": false,
"wrapAttributes": true,
"sortAttributes": false
},
"js-beautify-html": {
"wrap_attributes": "aligned-multiple",
"wrap_line_length": 120,
"end_with_newline": false,
"semi": true,
"singleQuote": true
},
"prettier": {
// 使用单引号
"singleQuote": true,
// 语句后分号
"semi": true,
// 对象最后一个属性不添加逗号
"trailingComma": "none"
}
},
"explorer.confirmDelete": false,
"explorer.confirmDragAndDrop": false,
"editor.renderControlCharacters": true,
"editor.renderWhitespace": "none",
"eslint.lintTask.options": "",
"diffEditor.ignoreTrimWhitespace": false,
"codemetrics.basics.CodeLensHiddenUnder": 20,
"workbench.iconTheme": "vscode-icons",
"eslint.format.enable": true,
"prettier.printWidth": 120,
"editor.wordWrapColumn": 120,
"prettier.endOfLine": "auto",
"prettier.ignorePath": ".prettierrc",
"prettier.requireConfig": true,
"prettier.proseWrap": "always",
"workbench.editor.wrapTabs": true,
"debug.console.wordWrap": false,
"html.format.wrapAttributes": "force",
"diffEditor.wordWrap": "off",
"git.confirmSync": false,
"window.zoomLevel": -1,
"workbench.sideBar.location": "right",
"workbench.colorTheme": "Monokai Pro (Filter Spectrum)",
"tabnine.experimentalAutoImports": true
}