原则:
prettier和eslint配置可以分成两种,一种是本地配置,一种是全局配置。VScode会检测文件夹根目录下有没有用户自定义的配置文件 .prettierrc.json和.eslintrc.js。如果有则会优先加载用户自定义的配置,如果没有则会加载VScode中的setting.json配置文件内的配置。
现在vscode安装prettier和eslint的插件,装使用人数最多的就行。注意的是,这个只是插件哦,在本地使用npm安装prettier和eslint
.prettierrc.json文件配置:
{
"tabWidth": 2,
"vetur.format.defaultFormatter.html": "prettier",
"singleQuote": true,
"semi": false
}
.eslintrc.js文件配置:
module.exports = {
root: true,
parserOptions: {
ecmaVersion:6,
sourceType: 'module',
ecmaFeatures:{
jsx:true,
globalReturn:true,
impliedStrict:false,
experimentalObjectRestSpread: true//启用对对象的扩展
}
},
env:{
browser:true,
es6:true,
node:true,
commonjs:true,
jquery:true
},
// required to lint files
plugins: [
'html',
'react',
'promise'
],
// add your custom rules here
'rules': {
// allow debugger during development
'no-debugger': process.env.NODE_ENV === 'production' ? 2 : 0,
"quotes": [2, "single"], // 单引号
"no-console": 0, // 不禁用console
"no-debugger": 2, // 禁用debugger
"semi": 0, // 不强制使用分号
"no-control-regex": 2, // 禁止在正则表达式中使用控制字符 :new RegExp("\x1f")
"linebreak-style": [0, "error", "windows"], // 强制使用一致的换行风格
"array-bracket-spacing": [2, 'never'], // 指定数组的元素之间要以空格隔开(,后面)
"brace-style": [2, '1tbs', {'allowSingleLine': true}], // if while function 后面的{必须与if在同一行,java风格。
"no-irregular-whitespace": 0, // 不规则的空白不允许
"no-trailing-spaces": 1, // 一行结束后面有空格就发出警告
"eol-last": 0, // 文件以单一的换行符结束
"no-unused-vars":0, // 不能有声明后未被使用的变量或参数
"no-underscore-dangle": 0, // 标识符不能以_开头或结尾
"no-alert": 2, // 禁止使用alert confirm prompt
"no-lone-blocks": 0, // 禁止不必要的嵌套块
"no-class-assign": 2, // 禁止给类赋值
"no-floating-decimal": 2, // 禁止数字字面量中使用前导和末尾小数点
"no-loop-func":1, // 禁止在循环中出现 function 声明和表达式
"no-cond-assign": 2, // 禁止在条件表达式中使用赋值语句
"no-delete-var": 2, // 不能对var声明的变量使用delete操作符
"no-dupe-keys": 2, // 在创建对象字面量时不允许键重复
"no-duplicate-case": 2, // switch中的case标签不能重复
"no-dupe-args": 2, // 函数参数不能重复
"no-empty": 2, // 块语句中的内容不能为空
"no-func-assign": 2, // 禁止重复的函数声明
"no-invalid-this": 0, // 禁止无效的this,只能用在构造器,类,对象字面量
"no-redeclare": 2, // 禁止重复声明变量
"no-spaced-func": 2, // 函数调用时 函数名与()之间不能有空格
"no-this-before-super": 0, // 在调用super()之前不能使用this或super
"no-undef": 1, // 不能有未定义的变量
"no-use-before-define": 2, // 未定义前不能使用
"camelcase": 0, // 强制驼峰法命名
//////////////
// React.相关 //
//////////////
"jsx-quotes": [2, "prefer-double"], // 强制在JSX属性(jsx-quotes)中一致使用双引号
"react/display-name": 0, // 防止在React组件定义中丢失displayName
"react/forbid-prop-types": [2, {"forbid": ["any"]}], // 禁止某些propTypes
"react/jsx-boolean-value": 2, // 在JSX中强制布尔属性符号
"react/jsx-closing-bracket-location": 1, // 在JSX中验证右括号位置
"react/jsx-curly-spacing": [2, {"when": "never", "children": true}], // 在JSX属性和表达式中加强或禁止大括号内的空格。
"react/jsx-indent-props": [2, 4], // 验证JSX中的props缩进
"react/jsx-key": 2, // 在数组或迭代器中验证JSX具有key属性
"react/jsx-no-bind": 0, // JSX中不允许使用箭头函数和bind
"react/jsx-no-duplicate-props": 2, // 防止在JSX中重复的props
"react/jsx-no-literals": 0, // 防止使用未包装的JSX字符串
"react/jsx-no-undef": 1, // 在JSX中禁止未声明的变量
"react/jsx-pascal-case": 0, // 为用户定义的JSX组件强制使用PascalCase
"react/jsx-uses-react": 1, // 防止反应被错误地标记为未使用
"react/jsx-uses-vars": 2, // 防止在JSX中使用的变量被错误地标记为未使用
"react/no-danger": 0, // 防止使用危险的JSX属性
"react/no-did-mount-set-state": 0, // 防止在componentDidMount中使用setState
"react/no-did-update-set-state": 1, // 防止在componentDidUpdate中使用setState
"react/no-direct-mutation-state": 2, // 防止this.state的直接变异
"react/no-multi-comp": 1, // 防止每个文件有多个组件定义
"react/no-set-state": 0, // 防止使用setState
"react/no-unknown-property": 2, // 防止使用未知的DOM属性
"react/prefer-es6-class": 2, // 为React组件强制执行ES5或ES6类
"react/prop-types": 0, // 防止在React组件定义中丢失props验证
"react/react-in-jsx-scope": 2, // 使用JSX时防止丢失React
"react/self-closing-comp": 0, // 防止没有children的组件的额外结束标签
"react/sort-comp": 1, // 强制组件方法顺序
"no-extra-boolean-cast": 0, // 禁止不必要的bool转换
"react/no-array-index-key": 0, // 防止在数组中遍历中使用数组key做索引
"react/no-deprecated": 1, // 不使用弃用的方法
"react/jsx-equals-spacing": 2, // 在JSX属性中强制或禁止等号周围的空格
"react/jsx-filename-extension": [1, { "extensions": [".js", ".jsx"] }], // 允许在 .js 和 .jsx 文件中使用 jsx
"no-unreachable": 1, // 不能有无法执行的代码
"comma-dangle": 2, // 数组和对象键值对最后一个逗号, never参数:不能带末尾的逗号, always参数:必须带末尾的逗号
"comma-spacing": [2, {'before': false, 'after': true}], // 控制逗号前后的空格
"no-mixed-spaces-and-tabs": 0, // 禁止混用tab和空格
"prefer-arrow-callback": 0, // 比较喜欢箭头回调
//////////////
// ES6.相关 //
//////////////
"arrow-body-style": 2, // 要求箭头函数体使用大括号
"arrow-parens": ["error", "as-needed"], // 要求箭头函数的参数可以省略圆括号时必须省略,配合prettier
"arrow-spacing":[2,{ "before": true, "after": true }],
"constructor-super": 0, // 强制在子类构造函数中用super()调用父类构造函数,TypeScrip的编译器也会提示
"no-const-assign":2, // 禁止修改 const 声明的变量
"no-dupe-class-members":2,// 禁止类成员中出现重复的名称
"no-this-before-super": 2,// 禁止在构造函数中,在调用 super() 之前使用 this 或 super
"no-var": 0, // 要求使用 let 或 const 而不是 var
"object-shorthand": 0, // 要求或禁止对象字面量中方法和属性使用简写语法
"prefer-template":0, // 要求使用模板字面量而非字符串连接
}
}
注意:
“arrow-parens”: [“error”, “as-needed”] 这一属性需要配合prettier使用。关于箭头函数一个参数时是否省略括号。如果没配置好会起冲突
很多时候prettier会和eslint冲突,而在一个多人合作的项目中不可以随意修改eslint使得eslint和prettier兼容。因而我们通常设置保存时不自动format。format可以由我们手动格式化。快捷键是shift+option+s (mac)是这样的。然后再ctrl+s进行eslint修正。