posts/2022-12-26-cz-git-czg-journey-zh

[giscus[bot]]

posts/2022-12-26-cz-git-czg-journey-zh

为什么会开发 cz-git 和 czg，我的开发心路历程

https://www.qbb.sh/posts/2022-12-26-cz-git-czg-journey-zh

[Zhengqbbb]

嘿嘿~ 开心，登上了阮一峰的周刊啦 🥳️

[Zhengqbbb]

嘿嘿，收录到 Awesome Node.js Utilities modules 之中了🥳️，但是好像 logo 用错了 🤣 用成博客的 logo 了

[Sinosaurus]

挺好的，加油，我先集成到lint工具里

[hsw15192617273]

你好, 想请教一下和(cz-cli)[https://github.com/commitizen/cz-cli]的区别在哪里
最近也在找commit工具, 都还没有深入了解过

[Zhengqbbb]

https://cz-git.qbb.sh/zh/guide/
关键在于使用体验上吧，可以两个都使用一下，对比使用体验

[Zhengqbbb]

可以看看这个。我写的不同点在哪：https://cz-git.qbb.sh/zh/guide/why

[qiqihaobenben]

搞了一个 commit 友好的初始化工具cz-relax，默认的adapter是cz-git，有需要可以用一下试试：https://github.com/qiqihaobenben/commitizen-relax/blob/release/docs/zh.md，有问题可以提issue或者pr。

[qiqihaobenben]

https://github.com/qiqihaobenben/commitizen-relax/blob/release/docs/zh.md

[Zhengqbbb]

Nice~ 感谢你将 cz-git 作为默认的commitizen 适配器
还想问一下，当前 cz-git 你觉得有改进的地方吗

[qiqihaobenben]

有一个不算是建议，单纯是个人使用的困扰，sope为空时，能否把 custom 和 empty 这两个选项换一下，默认选择的是empty，因为既然scope列表为空了，大概率可能也不会填scope。如果认为合理的话，我可以尝试做一下这个。

[Zhengqbbb]

有一个不算是建议，单纯是个人使用的困扰，sope为空时，能否把 custom 和 empty 这两个选项换一下，默认选择的是empty，因为既然scope列表为空了，大概率可能也不会填scope。如果认为合理的话，我可以尝试做一下这个。

可以~ 先起个issue，后续讨论可以在issue当中

[Petter-li]

大佬，能不能出个简易版的教程。想学习如何自定义一个提交工具。。。

[Zhengqbbb]

大佬，能不能出个简易版的教程。想学习如何自定义一个提交工具。。。

🤔 可恶没想到中文文档这么薄弱。
想要什么需求，或者你可以建一个最小化demo仓库 我来看看

还是说不知道怎么启动呢

[Zhengqbbb]

@Petter-li 做了一个简易版的 playground：你可以看看
czgit-playground

[Petter-li]

大佬可能误会我的意思了，我是想自己写一个gitcommit的信息提交工具，想学习您是怎么写出cz-git的。比如为何运行cz命令后会执行Npm包等等实现细节。

[qiqihaobenben]

那应该去看 commitizen/cz-cli 的源码， @Zhengqbbb 写的是一个 adpater，执行 cz的时候，如果配置的是cz-git，cz会去调用cz-git的方法得到commit message 而已。

带着问题去看，一步一步的来，cz的执行逻辑的代码是在 https://github.com/commitizen/cz-cli/blob/master/src/cli/git-cz.js 中的 bootstrap 函数中，再往下走会看到 https://github.com/commitizen/cz-cli/blob/master/src/cli/strategies/git-cz.js 中有个getPrompter(adapterConfig.path);

/**
 * Gets the prompter from an adapter given an adapter path
 */
function getPrompter (adapterPath) {
  // Resolve the adapter path
  let resolvedAdapterPath = resolveAdapterPath(adapterPath);

  // Load the adapter
  let adapter = require(resolvedAdapterPath);

  /* istanbul ignore next */
  if (adapter && adapter.prompter && isFunction(adapter.prompter)) {
     return adapter.prompter;
  } else if (adapter && adapter.default && adapter.default.prompter && isFunction(adapter.default.prompter)) {
     return adapter.default.prompter;
  } else {
    throw new Error(`Could not find prompter method in the provided adapter module: ${adapterPath}`);
  }
}

然后再去 cz-git 源码中看一下它有没有一个 prompter 函数。

[Petter-li]

感谢！

[Zhengqbbb]

上榜 awesome-cli-apps 🥳 开心，赶紧把墨镜带上 😎😎😎