Skip to content

🔍 GetEnvVariable

读取一个 Composer 环境变量的当前值。等价于调用 Go 标准库的 os.Getenv,未设置时返回空字符串。

何时使用

需要在程序中检查 Composer 运行环境配置(如主目录、缓存目录、是否禁用交互)时使用。常用于诊断或根据环境做条件分支。

签名

go
func GetEnvVariable(name EnvironmentVariable) string

参数

参数类型说明
nameEnvironmentVariable环境变量名,使用预定义常量如 EnvComposerCacheDir

返回值

返回值类型说明
唯一返回值string变量值;未设置时为空字符串

示例

go
package main

import (
	"fmt"

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

func main() {
	home := composer.GetEnvVariable(composer.EnvComposerHome)
	if home == "" {
		home = "(未设置,使用默认值)"
	}
	fmt.Printf("COMPOSER_HOME = %s\n", home)
}

进阶

  • 设置环境变量用 SetEnvVariable
  • 想一次性拿到 Composer 全部配置项可调用 GetEnvironmentInfo(基于 composer config --list)。
  • 该函数是包级函数,仅读取进程环境,不影响 Composer 实例的 Env 字段。

基于 MIT 许可证发布