init - 初始化配置
初始化 GitHub Flow 配置文件。
使用方法
bash
gfl init [flags]说明
init 命令会在当前项目目录创建两个配置文件：
.gfl.config.yml- 全局配置文件，应提交到版本控制.gfl.config.local.yml- 本地配置文件，不提交到版本控制
自动将 .gfl.config.local.yml 添加到 .gitignore 文件。
标志
| 标志 | 简写 | 说明 |
|---|---|---|
--force | -f | 强制覆盖已存在的配置文件 |
--nickname | -n | 设置开发者标识 |
示例
基本使用
bash
gfl init设置开发者标识
bash
gfl init --nickname john强制覆盖配置
bash
gfl init --force生成的配置文件
.gfl.config.yml（全局配置）
yaml
devBaseBranch: dev
productionBranch: main
nickname: aric
debug: false
featurePrefix: feature
fixPrefix: fix
hotfixPrefix: hotfix
branchCaseFormat: original.gfl.config.local.yml（本地配置）
yaml
nickname: ""
debug: false最佳实践
- 团队协作：将
.gfl.config.yml提交到版本控制，确保团队成员使用相同的基础配置 - 个性化设置：在
.gfl.config.local.yml中设置个人nickname，不提交此文件 - 分支命名：使用有意义的
nickname来区分不同开发者的分支
原理说明
init 命令通过以下步骤实现：
- 读取嵌入在程序中的默认配置模板
- 根据命令行参数（如
--nickname）修改配置内容 - 创建
.gfl.config.yml文件（如果不存在或使用--force） - 创建
.gfl.config.local.yml文件 - 将
.gfl.config.local.yml添加到.gitignore文件
此命令不涉及 Git 操作，仅进行文件系统操作。