本文详细介绍了如何在VSCode中设置setting.json，配置ESLint进行代码质量检查，Prettier统一代码格式，以及Vetur对Vue项目的特殊优化。包括tabSize、格式化规则、验证插件及Vue代码风格等。
setting.json配置
.vscode中setting.json配置（优先级大于上面的）
{
// vscode默认启用了根据文件类型自动设置tabsize的选项
"editor.detectIndentation": false,
// 重新设定tabsize
"editor.tabSize": 2,
// #每次保存的时候自动格式化
"editor.formatOnSave": true,
// eslint配置项，保存时自动修复错误
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true
},
// 添加 vue 支持
"eslint.validate": ["javascript", "javascriptreact", "html", "vue"],
// #让函数(名)和后面的括号之间加个空格
"javascript.format.insertSpaceBeforeFunctionParenthesis": true,
// // 图标主题（需要安装插件：vscode-icons-mac）
// "workbench.iconTheme": "vscode-icons-mac",
// //打开文件不覆盖
// "workbench.editor.enablePreview": false,
// 设置不同文件使用的格式化配置（这里用的是vscode安装的prettier格式化插件）
"[html]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[javascript]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[json]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[jsonc]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
// 对vue的配置
"[vue]": {
"editor.defaultFormatter": "octref.vetur"
},
"vetur.format.defaultFormatter.css": "prettier",
"vetur.format.defaultFormatter.postcss": "prettier",
"vetur.format.defaultFormatter.scss": "prettier",
"vetur.format.defaultFormatter.less": "prettier",
"vetur.format.defaultFormatter.stylus": "stylus-supremacy",
"vetur.format.defaultFormatter.ts": "prettier",
// vetur 缩进
"vetur.format.options.tabSize": 2,
"vetur.format.options.useTabs": false,
// #这个按用户自身习惯选择//格式化.vue中html, 直接这样写，不做配置的话是不换行的
// "vetur.format.defaultFormatter.html": "js-beautify-html",
"vetur.format.defaultFormatter.html": "prettyhtml",
// #vue组件中html代码格式化样式
"vetur.format.defaultFormatterOptions": {
// 选用beautify作为格式化vue中template的插件
"js-beautify-html": {
"wrap_line_length": 120, // 设置多个字符后换行 0 表示忽略
"wrap_attributes": "auto", // html 标签属性 换行设置[auto|force|force-aligned|force-expand-multiline] ["auto"]
"end_with_newline": false // 在文件结尾添加新行
},
// 选用pretty作为格式化vue中template的插件
// 与.prettierrc.js文件中的printWidth保持一致，这样npm run prettier时候就与手动保存时候格式一致
"prettyhtml": {
"printWidth": 120,
"singleQuote": false,
"wrapAttributes": false,
"sortAttributes": false,
"trailingComma": false,
"bracketSpacing": true
}
},
"prettier.vueIndentScriptAndStyle": true //缩进Vue文件中style和script
}
.eslintrc.js配置
// huangliang
module.exports = {
root: true,
parserOptions: {
parser: 'babel-eslint',
sourceType: 'module'
},
// 配置的环境
env: {
browser: true,
node: true,
es6: true
},
extends: ['plugin:vue/recommended', 'eslint:recommended'],
rules: {
// js规范
'no-array-constructor': 2, //禁止使用数组构造器 Array(0, 1, 2)
'no-bitwise': 2, //禁止使用按位运算符 var x = 1 | 2,
'no-caller': 1, //禁止使用arguments.caller或arguments.callee
'no-cond-assign': 2, //禁止在条件表达式中使用赋值语句
'no-continue': 0, //禁止使用continue
'no-control-regex': 2, //禁止在正则表达式中使用控制字符
'no-delete-var': 2, //不能对var声明的变量使用delete操作符
'no-div-regex': 1, //不能使用看起来像除法的正则表达式/=foo/
'no-dupe-keys': 2, //在创建对象字面量时不允许键重复 {a:1,a:1}
'no-dupe-args': 2, //函数参数不能重复
'no-duplicate-case': 2, //switch中的case标签不能重复
'no-else-return': 2, //如果if语句里面有return,后面不能跟else语句
'no-empty-character-class': 2, //正则表达式中的[]内容不能为空
'no-eq-null': 2, //禁止对null使用==或!=运算符
'no-eval': 1, //禁止使用eval
'no-ex-assign': 2, //禁止给catch语句中的异常参数赋值
'no-extend-native': 2, //禁止扩展native对象
'no-extra-bind': 2, //禁止不必要的函数绑定
'no-extra-boolean-cast': 2, //禁止不必要的bool转换
'no-extra-parens': 2, //禁止非必要的括号
'no-extra-semi': 2, //禁止多余的冒号
'no-fallthrough': 1, //禁止switch穿透
'no-floating-decimal': 2, //禁止省略浮点数中的0 .5 3.
'no-func-assign': 2, //禁止重复的函数声明
'no-implicit-coercion': 1, //禁止隐式转换
'no-implied-eval': 2, //禁止使用隐式eval
'no-inline-comments': 0, //禁止行内备注
'no-inner-declarations': [2, 'functions'], //禁止在块语句中使用声明（变量或函数）
'no-invalid-regexp': 2, //禁止无效的正则表达式
'no-invalid-this': 2, //禁止无效的this，只能用在构造器，类，对象字面量
'no-irregular-whitespace': 2, //不能有不规则的空格
'no-iterator': 2, //禁止使用__iterator__ 属性
'no-label-var': 2, //label名不能与var声明的变量名相同
'no-labels': 2, //禁止标签声明
'no-lone-blocks': 2, //禁止不必要的嵌套块
'no-lonely-if': 2, //禁止else语句内只有if语句
'no-loop-func': 1, //禁止在循环中使用函数（如果没有引用外部变量不形成闭包就可以）
'no-mixed-requires': [0, false], //声明时不能混用声明类型
'no-mixed-spaces-and-tabs': [2, false], //禁止混用tab和空格
'linebreak-style': [0, 'windows'], //换行风格
'no-multi-spaces': 1, //不能用多余的空格
'no-multi-str': 2, //字符串不能用\换行
'no-multiple-empty-lines': [1, { max: 2 }], //空行最多不能超过2行
'no-native-reassign': 2, //不能重写native对象
'no-negated-in-lhs': 2, //in 操作符的左边不能有!
'no-nested-ternary': 0, //禁止使用嵌套的三目运算
'no-new': 1, //禁止在使用new构造一个实例后不赋值
'no-new-func': 1, //禁止使用new Function
'no-new-object': 2, //禁止使用new Object()
'no-new-require': 2, //禁止使用new require
'no-new-wrappers': 2, //禁止使用new创建包装实例，new String new Boolean new Number
'no-obj-calls': 2, //不能调用内置的全局对象，比如Math() JSON()
'no-octal': 2, //禁止使用八进制数字
'no-octal-escape': 2, //禁止使用八进制转义序列
'no-param-reassign': 2, //禁止给参数重新赋值
'no-path-concat': 0, //node中不能使用__dirname或__filename做路径拼接
'no-plusplus': 0, //禁止使用++，--
'no-process-env': 0, //禁止使用process.env
'no-process-exit': 0, //禁止使用process.exit()
'no-proto': 2, //禁止使用__proto__属性
'no-regex-spaces': 2, //禁止在正则表达式字面量中使用多个空格 /foo bar/
'no-restricted-modules': 0, //如果禁用了指定模块，使用就会报错
'no-return-assign': 1, //return 语句中不能有赋值表达式
'no-script-url': 0, //禁止使用javascript:void(0)
'no-self-compare': 2, //不能比较自身
'no-sequences': 0, //禁止使用逗号运算符
'no-catch-shadow': 2, //禁止catch子句参数与外部作用域变量同名
'no-shadow': 2, //外部作用域中的变量不能与它所包含的作用域中的变量或参数同名 var err=''; catch(err)
'no-shadow-restricted-names': 2, //严格模式中规定的限制标识符不能作为声明时的变量名使用
'no-spaced-func': 2, //函数调用时 函数名与()之间不能有空格
'no-sparse-arrays': 2, //禁止稀疏数组， [1,,2]
'no-sync': 0, //nodejs 禁止同步方法
'no-ternary': 0, //禁止使用三目运算符
'no-trailing-spaces': 1, //一行结束后面不要有空格
'no-this-before-super': 0, //在调用super()之前不能使用this或super
'no-throw-literal': 2, //禁止抛出字面量错误 throw "error";
'no-undef-init': 2, //变量初始化时不能直接给它赋值为undefined
// 'no-undefined': 2, //不能使用undefined
'no-unexpected-multiline': 2, //避免多行表达式
'no-underscore-dangle': 1, //标识符不能以_开头或结尾
'no-unneeded-ternary': 2, //禁止不必要的嵌套 var isYes = answer === 1 ? true : false;
'no-unreachable': 2, //不能有无法执行的代码
'no-unused-expressions': 2, //禁止无用的表达式
'no-use-before-define': 2, //未定义前不能使用
'no-useless-call': 2, //禁止不必要的call和apply
'no-void': 2, //禁用void操作符
'no-var': 0, //禁用var，用let和const代替
'no-warning-comments': [1, { terms: ['todo', 'fixme', 'xxx'], location: 'start' }], //不能有警告备注
'no-with': 2, //禁用with
'array-bracket-spacing': [2, 'never'], //是否允许非空数组里面有多余的空格
'arrow-parens': 0, //箭头函数用小括号括起来
'arrow-spacing': 0, //=>的前/后括号
'accessor-pairs': 0, //在对象中使用getter/setter
'block-scoped-var': 0, //块语句中使用var
'brace-style': [1, '1tbs'], //大括号风格
'callback-return': 1, //避免多次调用回调什么的
camelcase: 2, //强制驼峰法命名
'comma-dangle': [2, 'never'], //对象字面量项尾不能有逗号
'comma-spacing': 0, //逗号前后的空格
'comma-style': [2, 'last'], //逗号风格，换行时在行首还是行尾
complexity: [0, 11], //循环复杂度
'computed-property-spacing': [0, 'never'], //是否允许计算后的键名什么的
'consistent-return': 0, //return 后面是否允许省略
'consistent-this': [2, 'that'], //this别名
'constructor-super': 0, //非派生类不能调用super，派生类必须调用super
curly: [2, 'all'], //必须使用 if(){} 中的{}
'default-case': 2, //switch语句最后必须有default
'dot-location': 0, //对象访问符的位置，换行的时候在行首还是行尾
'dot-notation': [0, { allowKeywords: true }], //避免不必要的方括号
'eol-last': 0, //文件以单一的换行符结束
eqeqeq: 2, //必须使用全等
'func-names': 0, //函数表达式必须有名字
'func-style': [0, 'declaration'], //函数风格，规定只能使用函数声明/函数表达式
'generator-star-spacing': 0, //生成器函数*的前后空格
'guard-for-in': 0, //for in循环要用if语句过滤
'handle-callback-err': 0, //nodejs 处理错误
'init-declarations': 0, //声明时必须赋初值
'key-spacing': [0, { beforeColon: false, afterColon: true }], //对象字面量中冒号的前后空格
'lines-around-comment': 0, //行前/行后备注
'max-depth': [0, 3], //嵌套块深度
'max-len': [0, 80, 4], //字符串最大长度
'max-nested-callbacks': [0, 2], //回调嵌套深度
'max-params': [0, 3], //函数最多只能有3个参数
'max-statements': [0, 10], //函数内最多有几个声明
'new-cap': 2, //函数名首行大写必须使用new方式调用，首行小写必须用不带new方式调用
'new-parens': 2, //new时必须加小括号
'newline-after-var': 2, //变量声明后是否需要空一行
'object-curly-spacing': [0, 'never'], //大括号内是否允许不必要的空格
'object-shorthand': 0, //强制对象字面量缩写语法
'one-var': 1, //连续声明
'operator-assignment': [0, 'always'], //赋值运算符 += -=什么的
'operator-linebreak': [2, 'after'], //换行时运算符在行尾还是行首
'padded-blocks': 0, //块语句内行首行尾是否要空行
'prefer-const': 0, //首选const
'prefer-spread': 0, //首选展开运算
'prefer-reflect': 0, //首选Reflect的方法
quotes: [0, 'single'], //引号类型 `` "" ''
// "quote-props": [2, "always"],//对象字面量中的属性名是否强制双引号
radix: 2, //parseInt必须指定第二个参数
'id-match': 0, //命名检测
'require-yield': 0, //生成器函数必须有yield
semi: [2, 'always'], //语句强制分号结尾
'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, //中缀操作符周围要不要有空格
'space-unary-ops': [0, { words: true, nonwords: false }], //一元运算符的前/后要不要加空格
'spaced-comment': 0, //注释风格要不要有空格什么的
strict: 2, //使用严格模式
'use-isnan': 2, //禁止比较时使用NaN，只能用isNaN()
'valid-jsdoc': 0, //jsdoc规则
'valid-typeof': 2, //必须使用合法的typeof的值
'vars-on-top': 2, //var必须放在作用域顶部
'wrap-iife': [2, 'inside'], //立即执行函数表达式的小括号风格
'wrap-regex': 0, //正则表达式字面量用小括号包起来
// 开启 console
'no-console': 'off',
// 禁止不必要的 catch 子句
'no-useless-catch': 'off',
// 禁止使用异步函数作为 Promise executor
'no-async-promise-executor': 'off',
// 可以出现未使用过的变量
'no-unused-vars': 'off',
// vue项目中，判断是否为生产环境，如果是的话，就提醒，否则话可以使用debugger
'no-debugger': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
// tab缩进为4空格
indent: [1, 2],
// 关闭下列提醒
// 'vue/no-template-shadow':'off', //
'vue/html-self-closing': 'off',
'vue/html-closing-bracket-newline': 'off',
'vue/max-attributes-per-line': 'off',
'vue/html-indent': 'off',
'vue/singleline-html-element-content-newline': [
'error',
{
ignoreWhenNoAttributes: true, // 当给定元素没有属性时，允许在一行中包含内容。默认true
ignoreWhenEmpty: true //当元素没有内容时禁用报告。默认true
// ignores: ['pre', 'textarea', ...INLINE_ELEMENTS] //元素名称的配置以忽略换行符样式。默认["pre", "textarea",
}
]
}
};
.eslintignore
/dist/
node_modules/
/*.js
.prettierrc.js
// .prettierrc.js
module.exports = {
printWidth: 120,
singleQuote: true, // 使用单引号而不是双引号
tabWidth: 2, // 会忽略vetur的tabSize配置
semi: true, // 句尾是否加;
useTabs: false, // 是否利用tab替代空格
trailingComma: 'none', // 多行时，尽可能打印尾随的逗号
arrowParens: 'avoid' // allow paren-less arrow functions 箭头函数的参数使用圆括号
};
.package.json
{
"name": "vue-config-eslint",
"version": "0.1.0",
"private": true,
"scripts": {
"serve": "vue-cli-service serve",
"build": "vue-cli-service build",
"lint": "vue-cli-service lint",
"prettier": "prettier --write '**/*.{js,css,scss,less,ts,vue,html}'"
},
"dependencies": {
"core-js": "^3.6.5",
"less": "^4.1.1",
"less-loader": "^10.0.1",
"vue": "^2.6.11"
},
"devDependencies": {
"@vue/cli-plugin-babel": "^4.5.0",
"@vue/cli-plugin-eslint": "^4.5.0",
"@vue/cli-service": "^4.5.0",
"@vue/eslint-config-prettier": "^6.0.0",
"babel-eslint": "^10.1.0",
"eslint": "^6.7.2",
"eslint-plugin-html": "^6.1.2",
"eslint-plugin-vue": "^7.8.0",
"husky": "^6.0.0",
"lint-staged": "^10.5.4",
"prettier": "^2.3.2",
"vue-template-compiler": "^2.6.11"
},
"eslintConfig": {
"root": true,
"env": {
"node": true
},
"extends": [
"plugin:vue/essential",
"eslint:recommended"
],
"parserOptions": {
"parser": "babel-eslint"
},
"rules": {}
},
"browserslist": [
"> 1%",
"last 2 versions",
"not dead"
],
"gitHooks": {
"pre-commit": "lint-staged"
},
"lint-staged": {
"*.{js,jsx,vue}": [
"vue-cli-service lint",
"git add"
]
}
}
项目源码:
https://gitee.com/hkduan/eslint_prettier_vetur
扫一扫
4756
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
