前言
不以规矩,不能成方圆。
本人有幸经历了团队从缺乏标准到逐渐规范
的一个过程,在此当做记录供大家参考。
从为什么需要规范
以及建立规范的重要性
出发,逐步引申出如何去建立适合自己团队的规范,详细讨论了前端具体涉及到的规范都有哪些,部分小节有具体的配置步骤和操作链接。
由于每个开发者的IDE不同,即使IDE相同也会因为每个人的配置不一样导致格式化的结果不一样。如何确保团队内开发人员采用统一的格式化配置呢?
这里给推荐大家使用 prettier,它内置了一套格式化的规则,具体配置:
1). 安装依赖:
npm install --save-dev --save-exact prettier
2). 创建一个空配置文件,让编辑器和其他工具知道你正在使用 Prettier:
echo {}> .prettierrc.json
3). 创建一个.prettierignore文件,让 Prettier CLI 和编辑器知道哪些文件不能格式化,example:
# Ignore artifacts:
dist
build
coverage
4). 配置编辑器(VScode为例)
IDE中安装 Prettier-Code Formater 插件:
找到IDE中设置模块,搜索 format On Save,勾上这个就可以了。
现在当我们 Ctrl + S 保存代码时,插件就会帮助我们自动格式化了。
这个自动格式化插件很好用,增加阅读理解速度,有了它再也不怕被说格式不标准了