Skip to content

📦 CreateSatisConfig

创建一个新的 Satis 配置文件(satis.json)。生成包含名称、主页、默认输出目录与 require-all 的基础配置并写入磁盘。

何时使用

当需要从零搭建一个私有 Composer 仓库(Satis)时,先用本方法生成基础配置,再用 AddSatisRepository / AddSatisRequire 等方法补充仓库与依赖。

签名

go
func (c *Composer) CreateSatisConfig(configPath string, name string, homepage string) error

参数

参数类型说明
configPathstring配置文件输出路径,例如 satis/satis.json
namestring仓库名称,例如 my-company/composer
homepagestring仓库主页 URL,用户从此处下载包

返回值

返回值类型说明
唯一返回值error序列化、创建目录或写文件失败时返回

默认值

生成的配置默认 OutputDirpublicRequireAlltrue。父目录不存在时会自动创建(权限 0755)。

示例

go
package main

import (
	"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.CreateSatisConfig(
		"satis/satis.json",
		"my-company/composer",
		"https://composer.example.com",
	); err != nil {
		log.Fatalf("创建 Satis 配置失败: %v", err)
	}
}

进阶

  • 想一次性初始化目录与配置用更便捷的 InitSatis
  • 配置创建后用 BuildSatis 构建仓库产物。
  • 添加仓库、依赖、归档等可用 AddSatisRepositoryAddSatisRequireEnableSatisArchive 等配套方法。

基于 MIT 许可证发布