Skip to content

config - 查看配置

显示当前 GFL 配置信息。

使用方法

bash
gfl config

别名

bash
gfl c

说明

config 命令以表格形式显示所有配置项的当前值及其来源(全局配置、本地配置、环境变量或默认值)。

示例

基本使用

bash
gfl config

输出示例:

┏━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┓
┃ 配置项        ┃ 最终值                  ┃ 来源            ┃
┡━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━┩
│ 调试模式      │ false                   │ 默认值          │
│ 开发基准分支  │ dev                     │ 全局配置        │
│ 生产分支      │ main                    │ 全局配置        │
│ 昵称          │ john                    │ 本地配置        │
│ 功能前缀      │ feature                 │ 全局配置        │
│ 修复前缀      │ fix                     │ 默认值          │
│ 热修复前缀    │ hotfix                  │ 默认值          │
│ 分支命名格式  │ kebab                   │ 本地配置        │
├──────────────┼─────────────────────────┼─────────────────┤
│ 示例功能分支  │ feature/john/new-feature │                 │
└──────────────┴─────────────────────────┴─────────────────┘

配置来源:
  🌍 全局配置: /path/to/project/.gfl.config.yml
  🏠 本地配置: /path/to/project/.gfl.config.local.yml

配置优先级:
  1. 自定义配置 (GFL_CONFIG_FILE)
  2. 本地配置
  3. 全局配置
  4. 默认值

快捷别名

bash
gfl c

显示信息

配置表格

说明
配置项配置项名称
最终值配置的最终生效值
来源配置值的来源(带颜色标识)

配置来源

来源颜色说明
自定义配置红色通过 GFL_CONFIG_FILE 环境变量指定的配置
本地配置黄色.gfl.config.local.yml 文件
全局配置蓝色.gfl.config.yml 文件
默认值青色程序内置的默认值

配置优先级

从高到低的优先级:

  1. 自定义配置 - GFL_CONFIG_FILE 环境变量指定的配置文件
  2. 本地配置 - .gfl.config.local.yml
  3. 全局配置 - .gfl.config.yml
  4. 默认值 - 程序内置的默认值

使用场景

检查配置是否生效

bash
# 修改配置后验证
gfl config

# 查看某项配置的来源

调试配置问题

bash
# 配置没有按预期工作?
gfl config

# 检查配置来源,确认是否使用了正确的配置文件

查看示例分支名

bash
gfl config
# 最后一行显示根据当前配置生成的示例分支名

与环境变量结合使用

bash
# 使用自定义配置文件
export GFL_CONFIG_FILE=/path/to/custom-config.yml

# 查看配置(会显示自定义配置优先)
gfl config

原理说明

config 命令通过以下步骤读取配置:

  1. 读取配置文件(按优先级从高到低):

    • 环境变量 GFL_CONFIG_FILE 指定的文件
    • .gfl.config.local.yml
    • .gfl.config.yml
    • 内置默认值
  2. 合并配置值

    • 后读取的配置会覆盖前面的同名配置
    • 记录每个配置项的来源
  3. 生成示例分支名

    bash
    # 使用配置生成分支名示例
    # {featurePrefix}/{nickname}/{feature-name}
    # 例如: feature/aric/new-feature

配置文件使用 YAML 格式,通过 gopkg.in/yaml.v3 解析。

注意事项

  • 此命令只读取配置,不会修改任何内容
  • 显示的是合并后的最终配置值
  • 示例分支名有助于验证配置是否符合预期

相关命令

基于 MIT 许可发布