前言
在项目开发过程中，我们通常需要频繁地提交代码，而存在众多的提交者可能会破坏代码版本控制以及团队合作的流程，使问题难以排查与解决。本文介绍一款名为 prefix-commit-message 的 npm 包，旨在帮助开发者规范化 commit message，以避免一系列问题的出现。
prefix-commit-message 是什么？
prefix-commit-message 是一款基于 Git Commit Message 规范化的 npm 包，通过强制提交者按照一定格式书写 Commit Message，以避免不规范的提交信息给项目开发带来的麻烦。
如何安装与使用
安装：
npm install prefix-commit-message -g
使用： 执行命令即可开启 Commit Message 规范化：
prefix-commit-message
规则说明
prefix-commit-message 规定了以下格式的 Commit Message：
<type>(<scope>): <subject> <description> <body> <footer>
其中，description、body、footer 可选。
类型（type）
type 用于说明 commit 的类别，只允许使用下面 7 个标识性词汇：
- feat: 新功能
- fix: 修复 Bug
- docs: 文档更新
- style: 代码格式更新，如缩进、空格、分号等，不影响代码运行
- refactor: 代码重构，既不是新增功能，也不是修复 Bug
- test: 测试用例更新
- chore: 其他更新，如构建流程、工程配置更新等
作用范围（scope）
scope 用于说明 commit 影响的范围，如模块、文件、文件夹等，可选项。目前已知的 scope 如以下：
- user: 用户模块
- blog: 博客模块
- api: 接口模块
描述（subject）
subject 是 commit 目的的简短描述，不超过 50 个字符，以动词开头，使用一般现在时。
详细描述（description）
description 主要对 commit 进行详细的描述，可以分为多行。
正文描述（body）
body 是对 commit 的详细描述，可以分为多行。
关闭（footer）
footer 是对 commit 进行 issue 关闭操作的描述。
实战练习
以下是一个规范化的 Commit Message 实例：
feat(api): 新增获取文章接口 完成了文章的增删改查，详情请见微信公众号
总结
prefix-commit-message 可以帮助开发者规范化 Commit Message，为版本控制、协作开发提供便利，如果团队的协作开发依然被提交不规范的信息所困扰，那么这个 npm 包将是非常有意的选择，毕竟，一定要从 Commit Message 开始！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600672693660cf7123b366ca