Skip to content

🚀 QuickSetup

一步完成 Composer 的检测、安装与初始化,返回可直接使用的 *Composer 实例。是最便捷的入口。

何时使用

当你希望用一行代码搞定全部环境准备、不想手动拼装 Options 与调用 EnsureInstalled 时使用。特别适合脚本、CLI 工具的启动入口。

签名

go
func QuickSetup(workingDir string, autoInstall bool) (*Composer, error)

参数

参数类型说明
workingDirstring工作目录路径,传空字符串则用当前目录
autoInstallbool是否在未检测到 Composer 时自动安装

返回值

返回值类型说明
第一返回值*Composer就绪的 Composer 实例
第二返回值error构造或安装失败时返回

示例

go
package main

import (
	"fmt"
	"log"

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

func main() {
	comp, err := composer.QuickSetup("/path/to/project", true)
	if err != nil {
		log.Fatalf("快速设置失败: %v", err)
	}
	fmt.Println("Composer 环境就绪 ✅")
	// 现在可以直接使用 comp 执行各种操作
}

进阶

  • 需要安装进度回调使用 QuickSetupWithProgress
  • 想精细控制各选项使用 New + DefaultOptions
  • 它内部会调用 EnsureInstalled,因此 autoInstall=true 时一定会确保可用。

基于 MIT 许可证发布