前言
Code standard
代码规范
是前端工程化落地的基石,用于约束 编码规范
和 编码风格
,它的好处是:
- 强制规范代码风格统一,保持一样的编码习惯
- 增加代码的可维护性和可接入性,即使有新成员的加入也能快速适应项目的架构与需求
- 保障项目的整体质量,可减少无用代码、重复代码、错误代码和 BUG 代码的产生几率
Git Commit Message
commit message
是开发的日常操作, 写好 log
不仅有助于他人 review
, 还可以有效的输出 CHANGELOG
, 对项目的管理实际至关重要, 但是实际工作中却常常被大家忽略.
那如何在前端项目中统一 代码规范,以及 Commit Message 的规范?
我这边结合实际项目以及目前较受欢迎的相关工具,给大家分享一套解决方案。
使用到的工具:
- eslint:JavaScript 代码检测工具,检测并提示错误或警告信息
- prettier:代码自动格式化工具,更好的代码风格效果
- husky:Git hooks 工具, 可以在执行 git 命令时,执行自定义的脚本程序
- lint-staged:对暂存区 (git add) 文件执行脚本检测校验
- commitlint:帮助你的团队遵守提交约定。通过支持 npm 安装的配置,它可以很容易地共享提交约定。