kickoff

type BufferedFile struct {
	// RelPath is the file path relative to root directory of the skeleton.
	// This is used to construct the path for the file relative to the the
	// target project directory.
	RelPath string `json:"relPath"`
	// Content holds the file contents.
	Content []byte `json:"content"`
	// Mode is the os.Mode for the file. This provides information about the
	// type of file, e.g. whether it is a directory or not.
	Mode os.FileMode `json:"mode"`
	// SkeletonRef contains the ref to the skeleton the file originated from or
	// nil if it does not belong to a specific skeleton. Used to keep track of
	// file origins during skeleton composition.
	SkeletonRef *SkeletonRef `json:"-"`
}

type Config struct {
	// Project holds default configuration values like default project host and
	// owner which are the same for new projects most of the time. Can be
	// overridden on project creation.
	Project ProjectConfig `json:"project,omitempty"`
	// Repositories holds a map of configured repositories to search for
	// available skeletons. Keys are the locally configured names for these
	// repositories.
	Repositories map[string]string `json:"repositories,omitempty"`
	// Values holds user-defined values that get merged on to of skeleton
	// values.
	Values template.Values `json:"values,omitempty"`
}

type Defaulter interface {
	// ApplyDefaults sets unset fields of the data structure to its default
	// values which might not necessarily be the zero value.
	ApplyDefaults()
}

type ProjectConfig struct {
	// Host holds the default git host's domain, e.g. 'github.com'.
	Host string `json:"host,omitempty"`
	// Owner holds the default repository owner name.
	Owner string `json:"owner,omitempty"`
	// License holds the name of the default open source license.
	License string `json:"license,omitempty"`
	// Gitignore holds a comma-separated list of gitignore templates, e.g.
	// 'go,hugo'.
	Gitignore string `json:"gitignore,omitempty"`
}

type RepoRef struct {
	// Name holds the optional local name for the repository.
	Name string `json:"name,omitempty"`
	// URL to the repository, e.g. 'https://github.com/foobar/baz' or
	// `/some/local/path`.
	URL string `json:"url,omitempty"`
	// Path is the path to a local repository.
	Path string `json:"path,omitempty"`
	// Revision holds the revision of the remote git repository to checkout.
	// This can be a branch, tag or commit SHA.
	Revision string `json:"revision,omitempty"`
}

type Repository interface {
	// GetSkeleton retrieves information about a skeleton from the repository.
	// Returns an error of type SkeletonNotFoundError if the named skeleton was
	// not found in the repository.
	GetSkeleton(name string) (*SkeletonRef, error)

	// ListSkeletons retrieves information about all skeletons in the
	// repository. If the repository is empty, ListSkeletons will return an
	// empty slice.
	ListSkeletons() ([]*SkeletonRef, error)

	// LoadSkeleton loads the skeleton with name from given repository. Returns
	// an error if loading the skeleton fails.
	LoadSkeleton(name string) (*Skeleton, error)

	// CreateSkeleton creates a new skeleton with name in the referenced
	// repository. Skeleton creation will fail with an error if ref does not
	// reference a local repository. The created skeleton contains an example
	// .kickoff.yaml and example README.md.skel as starter. Returns an error if
	// creating path or writing any of the files fails.
	CreateSkeleton(name string) (*SkeletonRef, error)
}

type Skeleton struct {
	// Description is the skeleton description text obtained from the skeleton
	// config.
	Description string `json:"description,omitempty"`
	// Ref holds the information about the location that was used to load the
	// skeleton. May be nil if the skeleton is the merged result of composing
	// multiple skeletons.
	Ref *SkeletonRef `json:"ref,omitempty"`
	// The Files slice contains a sorted list of files that are present in the
	// skeleton.
	Files []*BufferedFile `json:"files,omitempty"`
	// Values are the template values from the skeleton's metadata.
	Values template.Values `json:"values,omitempty"`
}

type SkeletonConfig struct {
	// Description holds a decription of the skeleton that can give some more
	// user-defined hints on the skeleton usage, e.g. interesting values to
	// tweak.
	Description string `json:"description,omitempty"`
	// Values holds user-defined values available in .skel templates.
	Values template.Values `json:"values,omitempty"`
}

type SkeletonRef struct {
	// Name of the skeleton. May include slashes if the skeleton is organized
	// in a subdirectory relative to the skeletons root.
	Name string `json:"name"`
	// Path contains the local path to the skeleton.
	Path string `json:"path"`
	// Repository references the repository where the skeleton can be found.
	Repo *RepoRef `json:"repo"`
}

type ValidationError struct {
	Context string
	Err     error
}

type Validator interface {
	// Validate returns an error if the data structure contains invalid values.
	Validate() error
}