internal

Documentation

Index

• Constants
• func Execute(ctx context.Context, w io.Writer, f input.Input) error
• func FileName(dir, name string) string
• func Header(comment, githubUrl string) string
• func Package(dir string) string
• func RegenerableFileName(dir, suffix string) string
• func StepSetUpGitIdentity() string

Constants

const (
	// RegenerableFilePrefix defines a prefix for files that can be
	// regenerated in a subsequent generator execution. Otherwise the file
	// is considered a scaffolding file which is generated once and
	// supposed to be edited by the user.
	//
	// NOTE: It is important to design scaffolding files in a way so they
	// stay compatible with regenerated files as they are not updated in
	// subsequent generator executions.
	RegenerableFilePrefix = "zz_generated."
)

Functions

func Execute

func Execute(ctx context.Context, w io.Writer, f input.Input) error

func FileName

func FileName(dir, name string) string

func Header

func Header(comment, githubUrl string) string

func Package

func Package(dir string) string

Package returns Go package name for the give directory.

func RegenerableFileName

func RegenerableFileName(dir, suffix string) string

RegenerableFileName returns file name prefixed with "zz_generated." denoting that it be regenerated in a subsequent generator execution. Otherwise the file is considered a scaffolding file which is generated once and supposed to be edited by the user.

NOTE: It is important to design scaffolding files in a way so they stay compatible with regenerated files as they are not updated in subsequent generator executions.

func StepSetUpGitIdentity

func StepSetUpGitIdentity() string