单独使用 czg 进行全局配置的一些问题

[JXY415]

作者大大你好
Windows 11环境下
只是单独全局安装了czg
npm install -g czg
想使用全局配置的方式来使用czg
在$Home/.config/路径下增加.czrc配置文件

{
  "$schema": "https://cdn.jsdelivr.net/gh/Zhengqbbb/[email protected]/docs/public/schema/cz-git.json",
  "alias": { "fd": "docs: fix typos" },
  "messages": {
    "type": "Select the type of change that you're committing:",
    "scope": "Denote the SCOPE of this change (optional):",
    "customScope": "Denote the SCOPE of this change:",
    "subject": "Write a SHORT, IMPERATIVE tense description of the change:\n",
    "body": "Provide a LONGER description of the change (optional). Use \"|\" to break new line:\n",
    "breaking": "List any BREAKING CHANGES (optional). Use \"|\" to break new line:\n",
    "footerPrefixesSelect": "Select the ISSUES type of changeList by this change (optional):",
    "customFooterPrefix": "Input ISSUES prefix:",
    "footer": "List any ISSUES by this change. E.g.: #31, #34:\n",
    "generatingByAI": "Generating your AI commit subject...",
    "generatedSelectByAI": "Select suitable subject by AI generated:",
    "confirmCommit": "Are you sure you want to proceed with the commit above?"
  },
  "types": [
    { "value": "feat", "name": "feat:     ✨ 新增功能 | A new feature", "emoji": ":sparkles:" },
    { "value": "fix", "name": "fix:      A bug fix", "emoji": ":bug:" },
    { "value": "docs", "name": "docs:     Documentation only changes", "emoji": ":memo:" },
    { "value": "style", "name": "style:    Changes that do not affect the meaning of the code", "emoji": ":lipstick:" },
    { "value": "refactor", "name": "refactor: A code change that neither fixes a bug nor adds a feature", "emoji": ":recycle:" },
    { "value": "perf", "name": "perf:     A code change that improves performance", "emoji": ":zap:" },
    { "value": "test", "name": "test:     Adding missing tests or correcting existing tests", "emoji": ":white_check_mark:" },
    { "value": "build", "name": "build:    Changes that affect the build system or external dependencies", "emoji": ":package:" },
    { "value": "ci", "name": "ci:       Changes to our CI configuration files and scripts", "emoji": ":ferris_wheel:" },
    { "value": "chore", "name": "chore:    Other changes that don't modify src or test files", "emoji": ":hammer:" },
    { "value": "revert", "name": "revert:   Reverts a previous commit", "emoji": ":rewind:" }
  ],
  "useEmoji": true,
  "emojiAlign": "center",
  // 配置................................
}

可以看到自定义的配置似乎没有识别到，也没有生效，但是ai config-file却是识别到了

但是如果将.czrc配置文件移动到$Home路径下就可以识别到，但是useEmoji选项似乎没有成功应用，commit message中依旧没有Emoji

如果使用js的方式配置，在$Home/路径下增加cz.config.js配置文件

const { definePrompt } = require('czg')

module.exports = definePrompt({
    alias: { fd: 'docs: fix typos' },
    messages: {
        type: 'Select the type of change that you\'re committing:',
        scope: 'Denote the SCOPE of this change (optional):',
        customScope: 'Denote the SCOPE of this change:',
        subject: 'Write a SHORT, IMPERATIVE tense description of the change:\n',
        body: 'Provide a LONGER description of the change (optional). Use "|" to break new line:\n',
        breaking: 'List any BREAKING CHANGES (optional). Use "|" to break new line:\n',
        footerPrefixesSelect: 'Select the ISSUES type of changeList by this change (optional):',
        customFooterPrefix: 'Input ISSUES prefix:',
        footer: 'List any ISSUES by this change. E.g.: #31, #34:\n',
        generatingByAI: 'Generating your AI commit subject...',
        generatedSelectByAI: 'Select suitable subject by AI generated:',
        confirmCommit: 'Are you sure you want to proceed with the commit above?',
    },
    types: [
        { value: 'feat', name: 'feat:     ✨ 新增功能 | A new feature', emoji: ':sparkles:' },
        { value: 'fix', name: 'fix:      A bug fix', emoji: ':bug:' },
        { value: 'docs', name: 'docs:     Documentation only changes', emoji: ':memo:' },
        { value: 'style', name: 'style:    Changes that do not affect the meaning of the code', emoji: ':lipstick:' },
        { value: 'refactor', name: 'refactor: A code change that neither fixes a bug nor adds a feature', emoji: ':recycle:' },
        { value: 'perf', name: 'perf:     A code change that improves performance', emoji: ':zap:' },
        { value: 'test', name: 'test:     Adding missing tests or correcting existing tests', emoji: ':white_check_mark:' },
        { value: 'build', name: 'build:    Changes that affect the build system or external dependencies', emoji: ':package:' },
        { value: 'ci', name: 'ci:       Changes to our CI configuration files and scripts', emoji: ':ferris_wheel:' },
        { value: 'chore', name: 'chore:    Other changes that don\'t modify src or test files', emoji: ':hammer:' },
        { value: 'revert', name: 'revert:   Reverts a previous commit', emoji: ':rewind:' },
    ],
    useEmoji: true,
    emojiAlign: 'center',
    // 配置................................
})

会提示Cannot find module 'czg'

我不确定是不是我的配置方式有问题，如果我想要可以一个全局的配置文件应该怎么做呢，关于czg单独使用的这部分文档有些没看懂
另外commit message中的emoji是不是只需要启用 "useEmoji": true, 即可呢？

[Zhengqbbb]

在$Home/.config/路径下增加.czrc配置文件

❌ 这里不对，$HOME/.config/.czrc 是放置 AI 相关的配置，例如 AI token 等敏感信息，要和传统的配置路径进行区分

但是如果将.czrc配置文件移动到$Home路径下就可以识别到 ... 但是useEmoji选项似乎没有成功应用，commit message中依旧没有Emoji

这应该是可以的，但是没有 emoji 出现就说明有问题，我们需要进一步定位

如果使用 js 的方式配置，在$Home/路径下增加cz.config.js配置文件

❌ 这个报错事因为 HOME 目录没有找到 $HOME/node_modules/cz-git 这个包，故你需要去除 type helper definePrompt 函数的包裹 (那是给项目用的)

[Zhengqbbb]

咦 我复制配置没有复现

---

我们可以试试看最小化例子，仅只有 useEmoji $HOME/cz.config.js

module.exports = {
  useEmoji: true,
}

[JXY415]

感谢感谢，问题已经解决😊