项目开发中的质量保证
项目开发中的质量保证
项目开发过程中,难免会因为各种原因造成一时疏忽,导致代码质量下滑。我们没有办法杜绝工程师的失误,但通过一些行为和风格规范以及一些自动化的机制,能减少失误的出现频率,并减少团队的工作负担。本文从编码规范、开发流程规范、GIT Flow、单元测试等角度来分享我的一些经验。
编码规范
遵循同一个良好的编码规范,能极大地降低自己以及团队的心智负担。下面是一些公认优秀且推建的编码规范:
- 高内聚,低耦合
- 编写小型函数,一个函数只做一件事
- 适当地拆分源码文件
- 见名知意的命名,不要滥用缩写
具体到项目,还是要灵活运用规范。
代码样式规范
样式可以理解为风格、偏好。无论是单打独斗,还是多人共建,使用同一个代码样式,才能保证每次提交代码时,能够减少因代码样式变化导致的多余变化。为什么要避免这个?因为多余的、不影响代码功能的变化记录,会使你追溯代码更改时花更多的时间。如果每个人还使用了自己的代码格式化工具,那历史记录简直是个灾难。
在 Node.js 的世界中,推荐使用 ESLint + Prettier 对代码进行格式化。并记得分享你的配置。在引入 ESLint + Prettier 十分简单,WebStorm 和 VS Code 早已支持使用项目中的 ESLint 和 Prettier 规则了,快上车。
使用 Git Hook
GIT Hook 哦,不是像 Github 的 webhook 哈。Git Hook 能让我们在执行 GIT 动作前后执行一些自定义的 shell 命令。
为 Node.js 项目添加 lint-staged
npx mrm@2 lint-staged