skel

Documentation

Overview

Package skel seeds the embedded rocketclaw skeleton into workspaces.

Index

• func ListSetupFiles() ([]string, error)
• func ReadSetupFile(name string) ([]byte, error)
• func SyncInWithOverlays(workspace, workDir string, overlays []string, logger *slog.Logger) error
• type OverlayInfo
  • func OverlayInfos(workspace, workDir string, overlays []string) []OverlayInfo

Functions

func ListSetupFiles

func ListSetupFiles() ([]string, error)

ListSetupFiles returns every workspace-relative file path that `rocketclaw setup` can materialize.

func ReadSetupFile

func ReadSetupFile(name string) ([]byte, error)

ReadSetupFile returns the bytes for one workspace-relative embedded setup file.

func SyncInWithOverlays

func SyncInWithOverlays(workspace, workDir string, overlays []string, logger *slog.Logger) error

SyncInWithOverlays materializes embedded setup files, configured git overlays, and local overlays into workDir.

Types

type OverlayInfo

type OverlayInfo struct {
	Spec, URL, Ref, ClonePath string
}

OverlayInfo describes one configured git overlay materialized by SyncInWithOverlays.

func OverlayInfos

func OverlayInfos(workspace, workDir string, overlays []string) []OverlayInfo

OverlayInfos returns normalized configured overlay clone metadata in config order.