cz-git 项目教程

cz-git 项目教程

cz-git cz-git | czg 🛠️ DX first and more engineered, lightweight, customizable, standard output format Commitizen adapter and CLI 项目地址: https://gitcode.com/gh_mirrors/cz/cz-git

1. 项目的目录结构及介绍

cz-git/
├── bin/
│   └── czg
├── lib/
│   ├── cli.js
│   ├── commit.js
│   ├── config.js
│   └── utils.js
├── templates/
│   ├── commit-template.txt
│   └── config-template.json
├── .gitignore
├── package.json
├── README.md
└── LICENSE

• bin/: 存放可执行文件，如 czg。
• lib/: 存放项目的主要逻辑代码，包括命令行接口 (cli.js)、提交逻辑 (commit.js)、配置处理 (config.js) 和工具函数 (utils.js)。
• templates/: 存放项目的模板文件，如提交消息模板 (commit-template.txt) 和配置模板 (config-template.json)。
• .gitignore: 指定 Git 忽略的文件和目录。
• package.json: 项目的元数据和依赖管理文件。
• README.md: 项目的介绍和使用说明。
• LICENSE: 项目的开源许可证。

2. 项目的启动文件介绍

项目的启动文件是 bin/czg，这是一个可执行的 Node.js 脚本。它负责初始化命令行接口并调用 lib/cli.js 中的逻辑来处理用户输入的命令。

#!/usr/bin/env node

const { run } = require('../lib/cli');

run();

• #!/usr/bin/env node: 指定使用 Node.js 来执行该脚本。
• const { run } = require('../lib/cli');: 引入 lib/cli.js 中的 run 函数。
• run();: 调用 run 函数，启动命令行接口。

3. 项目的配置文件介绍

项目的配置文件主要位于 lib/config.js 和 templates/config-template.json 中。

lib/config.js

该文件负责处理项目的配置逻辑，包括读取和解析配置文件、验证配置项等。

const fs = require('fs');
const path = require('path');

const DEFAULT_CONFIG_PATH = path.join(__dirname, '../templates/config-template.json');

function loadConfig(configPath = DEFAULT_CONFIG_PATH) {
    if (!fs.existsSync(configPath)) {
        throw new Error('Config file not found');
    }
    return JSON.parse(fs.readFileSync(configPath, 'utf8'));
}

module.exports = {
    loadConfig
};

• DEFAULT_CONFIG_PATH: 默认的配置文件路径。
• loadConfig: 加载并解析配置文件的函数。

templates/config-template.json

这是一个配置文件模板，包含了项目的基本配置项。

{
    "commitMessageFormat": "conventional",
    "emojiSupport": true,
    "issuePrefix": "https://github.com/Zhengqbbb/cz-git/issues/"
}

• commitMessageFormat: 提交消息的格式，如 conventional。
• emojiSupport: 是否支持在提交消息中使用表情符号。
• issuePrefix: 问题链接的前缀，用于自动生成问题链接。

通过以上介绍，您可以更好地理解和使用 cz-git 项目。

cz-git cz-git | czg 🛠️ DX first and more engineered, lightweight, customizable, standard output format Commitizen adapter and CLI 项目地址: https://gitcode.com/gh_mirrors/cz/cz-git