scaffold

Documentation

Overview

Package scaffold provides a simple way to scaffold a project from a template

Index

• Variables
• func BuildVars(eng *engine.Engine, project *Project, vars engine.Vars) (engine.Vars, error)
• func Inject(r io.Reader, data string, at string, mode Mode) ([]byte, error)
• func MergeMaps[T any](maps ...map[string]T) map[string]T
• func QuestionGroupBy(questions []Question) [][]Question
• func RenderRWFS(eng *engine.Engine, args *RWFSArgs, vars engine.Vars) error
• func TestparseDefaultBool(t *testing.T)
• func TestparseDefaultString(t *testing.T)
• func TestparseDefaultStrings(t *testing.T)
• type AnyPrompt
  • func (p AnyPrompt) IsConfirm() bool
  • func (p AnyPrompt) IsInput() bool
  • func (p AnyPrompt) IsInputLoop() bool
  • func (p AnyPrompt) IsMultiSelect() bool
  • func (p AnyPrompt) IsSelect() bool
  • func (p AnyPrompt) IsTextInput() bool
• type Askable
  • func NewAskable(name string, key string, field huh.Field, fn func(vars engine.Vars) error) *Askable
  • func (a *Askable) String() string
• type AuthEntry
• type BasicAuth
• type Feature
• type Injectable
• type Messages
• type Mode
• type Options
• type Project
  • func LoadProject(fileSys fs.FS, opts Options) (*Project, error)
  • func (p *Project) AskQuestions(def map[string]any, e *engine.Engine, theme *huh.Theme) (map[string]any, error)
• type ProjectScaffoldFile
  • func ReadScaffoldFile(reader io.Reader) (*ProjectScaffoldFile, error)
• type Question
  • func (q Question) Description() string
  • func (q Question) Title() string
  • func (q Question) ToAskable(def any) *Askable
• type RCValidationError
• type RWFSArgs
• type RcValidationErrors
  • func (e RcValidationErrors) Error() string
• type Rewrite
• type ScaffoldRC
  • func DefaultScaffoldRC() *ScaffoldRC
  • func NewScaffoldRC(r io.Reader) (*ScaffoldRC, error)
  • func (rc *ScaffoldRC) Authenticator(pkgurl string) (transport.AuthMethod, bool)
  • func (rc *ScaffoldRC) Validate() error
• type Settings

Variables

var ErrInjectMarkerNotFound = errors.New("inject marker not found")

Functions

func BuildVars

func BuildVars(eng *engine.Engine, project *Project, vars engine.Vars) (engine.Vars, error)

BuildVars builds the vars for the engine by setting the provided vars under the "Scaffold" key and adding the project name and computed vars.

func Inject

func Inject(r io.Reader, data string, at string, mode Mode) ([]byte, error)

Inject will read the reader line by line and find the line that contains the string "at". It will then insert the data before that line.

func MergeMaps

func MergeMaps[T any](maps ...map[string]T) map[string]T

MergeMaps merges multiple maps into a single map. If a key is present in multiple maps, the value from the last map will be used.

func QuestionGroupBy

func QuestionGroupBy(questions []Question) [][]Question

func RenderRWFS

func RenderRWFS(eng *engine.Engine, args *RWFSArgs, vars engine.Vars) error

RenderRWFS renders a rwfs.RFS to a rwfs.WriteFS by compiling all files in the rwfs.ReadFS and writing the compiled files to the WriteFS.

func TestparseDefaultBool

func TestparseDefaultBool(t *testing.T)

func TestparseDefaultString

func TestparseDefaultString(t *testing.T)

func TestparseDefaultStrings

func TestparseDefaultStrings(t *testing.T)

Types

type AnyPrompt

type AnyPrompt struct {
	Message    *string   `yaml:"message"`
	Desciption *string   `yaml:"description"`
	Loop       bool      `yaml:"loop"`
	Default    any       `yaml:"default"`
	Confirm    *string   `yaml:"confirm"`
	Multi      bool      `yaml:"multi"`
	Options    *[]string `yaml:"options"`
}

func (AnyPrompt) IsConfirm

func (p AnyPrompt) IsConfirm() bool

func (AnyPrompt) IsInput

func (p AnyPrompt) IsInput() bool

func (AnyPrompt) IsInputLoop

func (p AnyPrompt) IsInputLoop() bool

func (AnyPrompt) IsMultiSelect

func (p AnyPrompt) IsMultiSelect() bool

func (AnyPrompt) IsSelect

func (p AnyPrompt) IsSelect() bool

func (AnyPrompt) IsTextInput

func (p AnyPrompt) IsTextInput() bool

type Askable

type Askable struct {
	Name  string
	Key   string
	Hook  func(vars engine.Vars) error
	Field huh.Field
}

func NewAskable

func NewAskable(name string, key string, field huh.Field, fn func(vars engine.Vars) error) *Askable

func (*Askable) String

func (a *Askable) String() string

type AuthEntry

type AuthEntry struct {
	Match regexp.Regexp `yaml:"match"`
	Basic BasicAuth     `yaml:"basic"`
	Token string        `yaml:"token"`
}

type BasicAuth

type BasicAuth struct {
	Username string `yaml:"username"`
	Password string `yaml:"password"`
}

type Feature

type Feature struct {
	Value string   `yaml:"value"`
	Globs []string `yaml:"globs"`
}

type Injectable

type Injectable struct {
	Name     string `yaml:"name"`
	Path     string `yaml:"path"`
	At       string `yaml:"at"`
	Mode     Mode   `yaml:"mode"`
	Template string `yaml:"template"`
}

type Messages

type Messages struct {
	Pre  string `yaml:"pre"`
	Post string `yaml:"post"`
}

type Mode

type Mode string

const (
	Before Mode = "before"
	After  Mode = "after"
)

type Options

type Options struct {
	NoClobber bool `yaml:"no_clobber"`
}

type Project

type Project struct {
	RootFS       rwfs.ReadFS
	NameTemplate string
	Name         string
	Conf         *ProjectScaffoldFile
	Options      Options
}

Project structure hold the project templates file system and configuration for rendering the project.

func LoadProject

func LoadProject(fileSys fs.FS, opts Options) (*Project, error)

func (*Project) AskQuestions

func (p *Project) AskQuestions(def map[string]any, e *engine.Engine, theme *huh.Theme) (map[string]any, error)

type ProjectScaffoldFile

type ProjectScaffoldFile struct {
	Skip      []string                  `yaml:"skip"`
	Questions []Question                `yaml:"questions"`
	Rewrites  []Rewrite                 `yaml:"rewrites"`
	Computed  map[string]string         `yaml:"computed"`
	Messages  Messages                  `yaml:"messages"`
	Inject    []Injectable              `yaml:"inject"`
	Features  []Feature                 `yaml:"features"`
	Presets   map[string]map[string]any `yaml:"presets"`
}

func ReadScaffoldFile

func ReadScaffoldFile(reader io.Reader) (*ProjectScaffoldFile, error)

type Question

type Question struct {
	Name     string    `yaml:"name"`
	Group    string    `yaml:"group"`
	Prompt   AnyPrompt `yaml:"prompt"`
	When     string    `yaml:"when"`
	Required bool      `yaml:"required"`
}

func (Question) Description

func (q Question) Description() string

func (Question) Title

func (q Question) Title() string

func (Question) ToAskable

func (q Question) ToAskable(def any) *Askable

type RCValidationError

type RCValidationError struct {
	Key   string
	Cause error
}

type RWFSArgs

type RWFSArgs struct {
	ReadFS  rwfs.ReadFS
	WriteFS rwfs.WriteFS
	Project *Project
}

type RcValidationErrors

type RcValidationErrors []RCValidationError

func (RcValidationErrors) Error

func (e RcValidationErrors) Error() string

type Rewrite

type Rewrite struct {
	From string `yaml:"from"`
	To   string `yaml:"to"`
}

type ScaffoldRC

type ScaffoldRC struct {
	// Settings define the settings for the scaffold application.
	Settings Settings `yaml:"settings"`

	// Defaults define a default value for a variable.
	//   name: myproject
	//   git_user: hay-kot
	//
	// These are injected into the template as variables for
	// every scaffold.
	Defaults map[string]any `yaml:"defaults"`

	// Aliases define a alias for a repository.
	// or filepath.
	//
	//   component: https://githublcom/hay-kot/scaffold-go-component
	//   cli: https://github.com/hay-kot/scaffold-go-cli
	Aliases map[string]string `yaml:"aliases"`

	// Shorts define a short name for a repository.
	// the key will be expanded into the value.
	//   gh: https://github.com
	//   gt: https://gitea.com
	//
	// This will allow you to use the short name in the scaffold
	//   gh:myorg/myrepo
	Shorts map[string]string `yaml:"shorts"`

	// Auth defines a list of auth entries that can be used to
	// authenticate with a remote SCM.
	Auth []AuthEntry `yaml:"auth"`
}

func DefaultScaffoldRC

func DefaultScaffoldRC() *ScaffoldRC

DefaultScaffoldRC returns a default scaffold rc file.

func NewScaffoldRC

func NewScaffoldRC(r io.Reader) (*ScaffoldRC, error)

NewScaffoldRC reads a scaffold rc file from the reader and returns a ScaffoldRC struct.

func (*ScaffoldRC) Authenticator

func (rc *ScaffoldRC) Authenticator(pkgurl string) (transport.AuthMethod, bool)

func (*ScaffoldRC) Validate

func (rc *ScaffoldRC) Validate() error

type Settings

type Settings struct {
	Theme styles.HuhTheme `yaml:"theme"`
}