免费生成网站的app,电销管理系统软件,wordpress更新4.9,在线网站建设系统前言 团队多人协同开发项目#xff0c;困扰团队管理的一个很大的问题就是#xff1a;无可避免地会出现每个开发者编码习惯不同、代码风格迥异#xff0c;为了代码高可用、可维护性#xff0c;需要从项目管理上尽量统一和规范代码。理想的方式需要在项目工程化方面#xff…前言 团队多人协同开发项目困扰团队管理的一个很大的问题就是无可避免地会出现每个开发者编码习惯不同、代码风格迥异为了代码高可用、可维护性需要从项目管理上尽量统一和规范代码。理想的方式需要在项目工程化方面借助可灵活配置的工具自动化解决。 而现在无论是开源项目还是成熟的团队项目根目录下出现了越来越多的配置文件这是前端项目在快速演变、逐渐完善健壮的一种表现那面对这些配置文件如果是一脸懵的状态傻傻分不清楚不太行。 本篇文章便来介绍跟编码风格、代码规范相关的几个场景的配置功能 ESLint、Prettier、EditorConfig 借助于EditorConfigPrettierESLint 的组合项目中通过统一约定配置可以在团队成员在代码开发过程中就检查、约束、美化代码统一编码风格且可以省去很多的沟通成本提前暴露代码缺陷减少后期二次修改代码的风险。
EditorConfig EditorConfig包含的内容比较少主要是配置我们的编辑器编写代码时的简单规则不足以满足项目更多需求
ESLint ESLint 是一个在 JavaScript 代码中通过规则模式匹配作代码识别和报告的插件化的检测工具它的目的是保证代码规范的一致性和及时发现代码问题、提前避免错误发生。 ESLint 的关注点是代码质量检查代码风格并且会提示不符合风格规范的代码。除此之外 ESLint 也具有一部分代码格式化的功能。
Lint发展历程 ESLint最初是由Nicholas C. Zakas ( JavaScript 高级程序设计 作者)于2013年6月创建的开源项目。它的目标是提供一个插件化的javascript代码检测工具。 JavaScript发展历程中出现的Lint工具JSLint-JSHint-ESLint/TSLint
JSLint是最早出现的 Lint 工具不支持灵活拓展及配置必须接受它所有规则JSHint 在 JSLint 的基础上提供了一定的配置项给了开发者较大的自由但无法添加自定义规则
Zakas创建ESLint的初衷就是觉得当时的JSHint存在局限性无法添加自定义规则。
ES6的出现后则让ESLint迅速大火。因为ES6新增了很多语法JSHint 短期内无法提供支持而 ESLint 只需要有合适的解析器以及拓展校验规则 就能够进行 Lint 检查。此时babel就为兼容ESLint开发了 babel-eslint解析器提供支持的同时也让ESLint成为最快支持 ES6 语法的 Lint 工具。
关于TSLint(已停止维护)
但自2019 年 1 月起根据 TSLint 的官方声明TSLint 正在慢慢被废弃并会逐步迁移到 ESLint作为代码检查的工具。至于停止维护的原因一是ESLint社区更活跃、越来越完善且社区对ESLint的拥护声浪越来越高相反TSLint则完善度不够二是在持续迭代、支持新特性的过程中发现TSLint 的规则运作方式存在架构性的性能问题相反的 ESLint 则具有更高效能的架构。
支持的配置文件格式
JavaScript- 使用 .eslintrc.js 然后输出一个配置对象。
YAML - 使用 .eslintrc.yaml 或 .eslintrc.yml 去定义配置的结构。
JSON - 使用 .eslintrc.json 去定义配置的结构ESLint 的 JSON 文件允许 JavaScript 风格的注释。
(弃用) - 使用 .eslintrc可以使 JSON 也可以是 YAML。
package.json - 在 package.json 里创建一个 eslintConfig属性在那里定义你的配置。如果同一个目录下有多个配置文件ESLint 只会使用一个。优先级顺序如下
.eslintrc.js
.eslintrc.yaml
.eslintrc.yml
.eslintrc.json
.eslintrc
package.json
遇到项目内有多个层叠配置时采用就近原则作为高优先级
Prettier Prettier是一个诞生于2016年就迅速流行起来的专注于代码格式化的工具。出道即巅峰。Prettier只关注格式化并不具有lint检查语法等能力。它通过解析代码并匹配自己的一套规则来强制执行一致的代码展示格式。它在美化代码方面有很大的优势配合ESLint可以对ESLint格式化基础上做一个很好的补充。
VSCode内置的代码格式化工具可以指定为由Prettier接管此时右下角会显示为Prettier。可以自行配置格式化触发机制换行时格式化、保存文件时格式化、还是自行快捷键触发
配置项
在VSCode 首选项-设置-扩展或.settings.json中更改通用配置
在具体项目根目录设置.prettierrc.js单独配置
module.exports {// 一行最多 120 字符printWidth: 120,// 使用 2 个空格缩进tabWidth: 2,// 不使用缩进符而使用空格useTabs: false,// 行尾需要有分号semi: false,// 使用单引号singleQuote: true,// 对象的 key 仅在必要时用引号quoteProps: as-needed,// jsx 不使用单引号而使用双引号jsxSingleQuote: false,// 末尾需要有逗号trailingComma: none,// 大括号内的首尾需要空格bracketSpacing: true,// jsx 标签的反尖括号需要换行jsxBracketSameLine: false,// 箭头函数只有一个参数的时候也需要括号arrowParens: always,// 每个文件格式化的范围是文件的全部内容rangeStart: 0,rangeEnd: Infinity,// 不需要写文件开头的 prettierrequirePragma: false,// 不需要自动在文件开头插入 prettierinsertPragma: false,// 使用默认的折行标准proseWrap: preserve,// 根据显示样式决定 html 要不要折行htmlWhitespaceSensitivity: css,// vue 文件中的 script 和 style 内不用缩进vueIndentScriptAndStyle: false,// 换行符使用 lfendOfLine: lf,// 格式化嵌入的内容embeddedLanguageFormatting: auto,// html, vue, jsx 中每个属性占一行singleAttributePerLine: false
}格式化的生效策略同样是就近原则一步步匹配目标文件最近父目录的配置文件越近优先级越高。
总结
1、在代码格式化时采用Perttier规则在代码校验时使用ESLint
2、遇到项目内有多个层叠配置时采用就近原则作为高优先级
3、ESLint等解决的是团队开发规范的问题并不能解决其他诸如编码能力、代码合理性等问题 还属于工程化中比较弱的一环。
EditorConfig 是用来抹平编辑器差异的比如文件编码锁进格式等ESLint 关注于代码质量校验 和 代码格式校验配合插件支持autoFix和错误提示完全可插拔Prettier Prettier只关注代码格式也支持自动修复规则和ESLint不同
QA
如何解决Prettier与ESLint的配置冲突问题
解决方式一要么修改 eslintrc要么修改 prettierrc 配置让它们配置保持一致
解决方式二禁用 ESLint中和Prettier配置有冲突的规则再使用 Prettier 来替代 ESLint 的格式化功能
