internal

package
v8.67.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 18, 2026 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source 
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."
)

Variables

This section is empty.

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(comment, githubUrl string) string

func IsInvalidInput added in v8.58.0 

func IsInvalidInput(err error) bool

IsInvalidInput asserts invalidInputError.

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

Types

This section is empty.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.