Documentation
¶
Overview ¶
Package skeleton contains types that define the structure of a skeleton and its config. It also provides helpers to find, create and merge skeletons.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ErrDirNotFound = errors.New("skeleton dir not found")
ErrDirNotFound indicates that a skeleton directory was not found.
Functions ¶
func Create ¶
Create creates a new skeleton at path. 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.
func FindSkeletonDir ¶
FindSkeletonDir finds the skeleton dir path resides in. It walk up the filesystem tree and checks for each parent if it is a skeleton dir and returns its path if the check was successful. Returns ErrDirNotFound if path does not reside within a skeleton dir or one of its subdirectories. Returns any other errors that may occur while traversing the filesystem tree.
func IsInsideSkeletonDir ¶
IsInsideSkeletonDir returns true if path is inside a skeleton dir. If path is a skeleton dir itself, this will return false.
func IsSkeletonDir ¶
IsSkeletonDir returns true if dir is a skeleton dir. Skeleton dirs are detected by the fact that they contain a .kickoff.yaml file.
Types ¶
This section is empty.
Source Files