Skip to content

🎯 SetPreferredInstall

设置项目的 preferred-install 配置,控制 Composer 安装包时优先使用 dist(打包分发版)还是 source(源代码),等价于执行 composer config preferred-install <value>

何时使用

当你想统一团队的安装策略时使用。例如生产环境优先 dist 以加快安装并避免拉取 Git 历史;调试场景优先 source 以便直接查看或修改源码。

签名

go
func (c *Composer) SetPreferredInstall(value string) error

参数

参数类型说明
valuestring安装策略,必须是 distsourceauto 三者之一

返回值

error:设置配置过程中发生错误时返回相应错误信息,成功时为 nil

注意

本方法会校验取值,仅接受 distsourceauto,传入其他值会直接返回错误。

示例

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

	// 优先使用打包分发版本
	if err := comp.SetPreferredInstall("dist"); err != nil {
		log.Fatalf("设置 preferred-install 失败: %v", err)
	}

	fmt.Println("preferred-install 已设置为 dist")
}

进阶

  • 想读取当前 preferred-install 配置,使用 GetPreferredInstall()
  • 取值含义:dist(优先分发版)、source(优先源码)、auto(自动选择,默认)。
  • 仅对单次安装生效的快捷方式:InstallWithPreferSource() / InstallWithPreferDist()

基于 MIT 许可证发布