Documentation
¶
Overview ¶
Package projectinit creates the on-disk Volcano project scaffold.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CheckStarter ¶ added in v0.48.0
CheckStarter returns the error RunStarter would return for starterName before it touches any file. Empty names the base scaffold.
func CheckStarterIn ¶ added in v0.48.0
CheckStarterIn returns the error RunStarterIn would return, without changing any file.
func ConflictMessages ¶
ConflictMessages returns formatted conflict details from an init error.
func ConflictsCanBeForced ¶
ConflictsCanBeForced reports whether --force can resolve every conflict in err.
Types ¶
type Result ¶
type Result struct {
// contains filtered or unexported fields
}
Result describes the filesystem changes made by one init run.
func RunStarter ¶
RunStarter creates the base scaffold plus an optional starter overlay.
func RunStarterIn ¶ added in v0.48.0
RunStarterIn adds the base scaffold and a starter to dir, a directory that may already hold some of it, as one `volcano connect` set up does. Unlike RunStarter, it keeps existing base scaffold files, which belong to the user once created, and appends the starter's missing lines to a .gitignore that differs. Other starter files that differ are conflicts, unless every starter file exists: then the starter is in place, and the files that differ are the user's changes, kept and listed in Result.Kept. It never overwrites.
func (*Result) Kept ¶ added in v0.48.0
Kept returns the starter files RunStarterIn left changed, because the starter was already in place.
func (*Result) Merged ¶ added in v0.48.0
Merged returns the .gitignore files RunStarterIn added starter lines to.
func (*Result) Overwritten ¶
Overwritten returns paths replaced because force mode was enabled.
Source Files