# 前端代码管理规范
- 确定一下分支管理的内容。
- 主分支:主分支是正式发布的分支,在真正开发完全前,都不应该合并到主分支上。
- 测试分支:测试情况下使用的分支,一般来说除了发布的域名与主分支不同外,应该都与主分支相同。
- DEV 分支:开发情况下的分支,可以每隔半天或者一天左右可以定期预览在某个服务器上。一般来说不用。 这几个是分支管理的几个内容,正常情况开发会直接 push 到 DEV 分支上,这其实不太好,也有点问题。
Code Review
# 单独分支
也就是说,假设现在我们有个版本 v1.0 的初版,就应该从 dev 上检出一个新的分支用作初版的开发,然后同学在在这个分支上继续检出,然后提交,请求负责人进行 code Review ,通过的代码在进行合并。
这里为什么不直接在 v1.0 版本上开发?如果直接在 v1.0 版本上开发,很容易导致代码风格不一,从而导致维护困难。通过这样子的方法,通过申请合并的方式,然后审核,修改,很大程度上可以规避上诉说的团队风格问题。
# 代码自动化检测
除了通过 code Review 的方式来统一代码,我们需要也更应该将一些重复繁杂、成效低的劳作交给自动化来做。
比如:JS、TS 文件命名规范、import 导入规范(不允许重复导入)、define but never use
这些不是 code Review 也不应该是该阶段所需要注意的,我们将这些能够自动化检测的内容交给脚本去做,让 code Review 更加注重于业务逻辑、复杂的交互上面。
前端这一块向来做的不错,有着 TypeScript 、Eslint 这一类的插件,还能自定义规范,编写脚本。
# 最佳实践
工程中自带 prettier 和 eslint ,并且有一套专属于自己的规则(参考大厂的也可以)
如果涉及到 TypeScript 的项目,一定要也只能使用 .ts 结尾的文件。 代码管理,在 push 代码前,一定要通过钩子跑一遍自定义脚本( husky、precommit ),规范一下代码。
# 个人一些总结
- 单个 JS 文件不应该超过 250 行代码(不包含注释)
# 参考
https://zhuanlan.zhihu.com/p/399424496
← 01.前端代码规范 03.项目代码管理规范 →