Commitizen 互联网公民的简单提交惯例

冷不防 2022-01-17 21:01 132阅读 0赞

## 安装命令行工具 ##

安装就像运行以下命令一样简单（如果看到 `EACCES` 错误，阅读 [修复 npm 权限][npm] 可能有帮助）：

npm install -g commitizen
    复制代码

## 使用命令行工具 ##

现在，只需使用 `git cz` 而不是 `git commit` 提交时。

*  或者 \*，如果您使用的是 **NPM 5.2+**，则可以 [使用 `npx`][_npx] 而不是全局安装：

npx git-cz
    复制代码

或者作为 npm 脚本：

...
      "scripts": {
        "commit": "npx git-cz"
      }
    复制代码

当您在 Commitizen 友好存储库中工作时，系统将提示您填写任何必填字段，并且您的提交消息将根据项目维护人员定义的标准进行格式化。

如果您不在 Commitizen 友好存储库中 `git cz` 工作，那么将使用相同 `git commit` 但 `npx git-cz` 将使用 [streamich / git-cz][streamich _ git-cz] 适配器。

#### 常规提交消息作为全局实用程序 ####

`commitizen` 如果您还没有全局安装。

npm install -g commitizen
    复制代码

`commitizen` 例如，全局安装首选适配器 [`cz-conventional-changelog`][cz-conventional-changelog]

npm install -g cz-conventional-changelog
    复制代码

`.czrc` 在 `home` 目录中创建一个文件，并 `path` 引用首选的全局安装的 `commitizen` 适配器

echo '{"path":"cz-conventional-changelog"}' > ~/.czrc
    复制代码

你们都准备好了！现在 `cd` 进入任何 `git` 存储库并使用 `git cz` 而不是，`git commit` 你会发现 `commitizen` 提示。

提示：可以使用所有 `git commit` `options` 带 `git cz`，例如：`git cz -a`。

参考：[commitizen.github.io/cz-cli/][commitizen.github.io_cz-cli]

转载于:https://juejin.im/post/5cd93616f265da03761eaae6

[npm]: https://link.juejin.im?target=https%3A%2F%2Fdocs.npmjs.com%2Fgetting-started%2Ffixing-npm-permissions
[_npx]: https://link.juejin.im?target=https%3A%2F%2Fmedium.com%2F%40maybekatz%2Fintroducing-npx-an-npm-package-runner-55f7d4bd282b
[streamich _ git-cz]: https://link.juejin.im?target=https%3A%2F%2Fgithub.com%2Fstreamich%2Fgit-cz
[cz-conventional-changelog]: https://link.juejin.im?target=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2Fcz-conventional-changelog
[commitizen.github.io_cz-cli]: https://link.juejin.im?target=http%3A%2F%2Fcommitizen.github.io%2Fcz-cli%2F