Skip to content

🏠 GetComposerHome

获取 Composer 的主目录(COMPOSER_HOME)路径。等价于执行 composer config --global home

何时使用

需要定位 Composer 存放全局配置、缓存、认证信息的目录时使用。常用于自定义工具需要读取 auth.json、清理缓存或备份全局配置的场景。

签名

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

参数

该方法无参数。

返回值

返回值类型说明
第一返回值stringComposer 主目录绝对路径(已去除首尾空白)
第二返回值error执行失败时返回

示例

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)
	}

	home, err := comp.GetComposerHome()
	if err != nil {
		log.Fatalf("获取 Composer 主目录失败: %v", err)
	}
	fmt.Println("Composer 主目录:", home)
}

进阶

  • 同类便捷方法还有 GetCacheDir()GetVendorDir()GetBinDir(),分别返回缓存、vendor、bin 目录。
  • 该方法本质是 GetConfigWithGlobalhome 项的全局读取快捷方式。
  • 清理缓存目录可使用 ClearCache

基于 MIT 许可证发布