一、背景
在公司中,有已经运行存在的项目,还有很多按照需求不断创建的项目。由于团队成员编码习惯不一,技术层次不同,为了保证项目质量和代码统一,需要在项目开发阶段、代码提交时校验代码,从而保证代码的质量和书写规范。
二、目标
- 统一代码规范
- 统一开发规范
三、 方案
1、JavaScript规范
前端代码规范采用 eslint + Airbnb Style Guide +prettier+git提交规范 +lighthouse
为了保证项目代码整体风格和代码校验效率,在项目中采用工具实现,工具如下:
| 标题 | 描述 |
|---|---|
| Eslin | ESLint 是一个插件化并且可配置的 JavaScript 语法规则和代码风格的检查工具。ESLint 能够帮你轻松写出高质量的 JavaScript 代码 |
| Prettier | 前端代码格式化工具 |
| Husky | husky是Git hooks 工具,可以防止使用 Git hooks 的一些不好的 commit 或者 push |
| lint-staged | 一个仅仅过滤出Git代码暂存区文件(被committed的文件)的工具。 |
| git-cz | 交互式 Git commit 配合 (commitizen)[github.com/commitizen/…] commitizen需全局安装 执行 git cz |