Skip to content

📚 ListScripts

列出 composer.json 中定义的所有脚本,等价于执行 composer run-script --list

何时使用

当你需要查看当前项目里有哪些可用脚本、或想在运行脚本前先确认脚本名称时使用。输出为 Composer 的标准文本列表。

签名

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

参数

该方法无参数。

返回值

返回值类型说明
第一返回值string所有脚本列表的标准输出文本
第二返回值error列出脚本过程中发生错误时返回,nil 表示成功

示例

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.ListScripts()
	if err != nil {
		log.Fatalf("列出脚本失败: %v", err)
	}

	fmt.Println("可用脚本:")
	fmt.Println(output)
}

进阶

  • 想以 map[string]interface{} 形式读取脚本定义,可使用 GetScripts() 方法,便于程序化处理。
  • 确认脚本名后,可用 RunScript(带参数)或 ExecuteScript(不带参数)触发执行。
  • 想新增或删除脚本定义,可使用 AddScript / RemoveScript 方法。

基于 MIT 许可证发布