Skip to content

📋 ListConfig

列出当前项目的所有 Composer 配置项及其值。等价于执行 composer config --list

何时使用

需要一次性查看当前项目生效的所有配置(含默认值、项目值、全局值的合并结果)时使用。适合在调试脚本或诊断工具中输出当前环境快照。

签名

go
func (c *Composer) ListConfig() (string, error)

参数

该方法无参数。

返回值

返回值类型说明
第一返回值stringcomposer config --list 的原始文本输出
第二返回值error执行失败时返回,错误信息会被 fmt.Errorf 包装为"列出配置失败"

示例

go
package main

import (
	"fmt"
	"log"

	"github.com/scagogogo/composer-skills/pkg/composer"
)

func main() {
	comp, err := composer.New(composer.DefaultOptions())
	if err != nil {
		log.Fatalf("初始化失败: %v", err)
	}

	output, err := comp.ListConfig()
	if err != nil {
		log.Fatalf("列出配置失败: %v", err)
	}
	fmt.Println(output)
}

进阶

  • 若要区分全局配置与项目配置,使用 ListConfigWithGlobal(global bool)
  • 若需要在程序中逐项处理,使用结构化版本 GetConfigStructured,返回 *ConfigResult
  • 读取单个配置项使用 GetConfigWithGlobal

基于 MIT 许可证发布