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
	// Content holds the file contents.
	Content []byte
	// FileMode is the os.FileMode for the file. This provides information
	// about the type of file, e.g. whether it is a directory or not.
	FileMode os.FileMode
}

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 File interface {
	// Path must return the path relative to the new project root.
	Path() string

	// Mode returns the mode of the file. The target in the project directory
	// will be created using this mode. The mode is also used to determine if
	// the file is regular or a directory.
	Mode() os.FileMode

	// Reader provides an io.Reader to read the contents of the file.
	Reader() (io.Reader, error)

	// IsTemplate returns true if the source is a template.
	IsTemplate() bool
}

type FileRef 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"`
	// AbsPath is the absolute path to the file on disk.
	AbsPath string `json:"absPath"`
	// FileMode is the os.FileMode for the file. This provides information
	// about the type of file, e.g. whether it is a directory or not.
	FileMode os.FileMode `json:"mode"`
}

type ParentRef struct {
	// SkeletonName holds the name of the parent skeleton. May include slashes
	// if the skeleton is organized in a subdirectory relative to the skeletons
	// root.
	SkeletonName string `json:"skeletonName"`
	// RepositoryURL can be a local path or are remote url to a skeleton
	// repository. If empty the parent is assumed to be in the same repository
	// as the child.
	RepositoryURL string `json:"repositoryURL,omitempty"`
}

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. The passed in context is propagated to all operations that
	// cross API boundaries (e.g. git operations) and can be used to enforce
	// timeouts or cancel them. Returns an error of type SkeletonNotFoundError
	// if the named skeleton was not found in the repository.
	GetSkeleton(ctx context.Context, name string) (*SkeletonRef, error)

	// ListSkeletons retrieves information about all skeletons in the
	// repository. The passed in context is propagated to all operations that
	// cross API boundaries (e.g. git operations) and can be used to enforce
	// timeouts or cancel them. If the repository is empty, ListSkeletons
	// will return an empty slice.
	ListSkeletons(ctx context.Context) ([]*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"`
	// Parent points to the parent skeleton if there is one.
	Parent *Skeleton `json:"parent,omitempty"`
	// The Files slice contains a merged and sorted list of file references
	// that includes all files from the skeleton and its parents (if any).
	Files []File `json:"files,omitempty"`
	// Values are the template values from the skeleton's metadata merged with
	// those of it's parents (if any).
	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"`
	// Parent references an optional parent skeleton.
	Parent *ParentRef `json:"parent,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
}