cli

package
v0.11.0 Latest Latest
Warning

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

 Go to latest Published: Jun 12, 2024 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source 
const CmdRootTemplate = `` /* 2222-byte string literal not displayed */

Variables

This section is empty.

Functions

This section is empty.

Types

type CmdGenerate 

type CmdGenerate struct {
	machinery.TemplateMixin
	machinery.BoilerplateMixin
	machinery.RepositoryMixin

	// input variables
	Initializer kinds.WorkloadBuilder

	// template variables
	GenerateCommandName  string
	GenerateCommandDescr string
}

CmdGenerate scaffolds the companion CLI's generate subcommand for component workloads. The generate logic will live in the workload's subcommand to this command; see cmd_generate_sub.go.

func (*CmdGenerate) SetTemplateDefaults 

func (f *CmdGenerate) SetTemplateDefaults() error

type CmdGenerateSub 

type CmdGenerateSub struct {
	machinery.TemplateMixin
	machinery.BoilerplateMixin
	machinery.RepositoryMixin
	machinery.ResourceMixin

	// input fields
	Builder kinds.WorkloadBuilder

	GenerateCommandName  string
	GenerateCommandDescr string
	GenerateFuncInputs   string
	// contains filtered or unexported fields
}

CmdGenerateSub scaffolds the companion CLI's generate subcommand for the workload. This where the actual generate logic lives.

func (*CmdGenerateSub) SetTemplateDefaults 

func (f *CmdGenerateSub) SetTemplateDefaults() error

type CmdGenerateSubUpdater 

type CmdGenerateSubUpdater struct {
	machinery.RepositoryMixin
	machinery.MultiGroupMixin
	machinery.ResourceMixin

	// input fields
	Builder kinds.WorkloadBuilder

	PackageName string
	// contains filtered or unexported fields
}

CmdGenerateSubUpdater updates a specific components version subcommand with appropriate initialization information.

func (*CmdGenerateSubUpdater) GetCodeFragments 

func (f *CmdGenerateSubUpdater) GetCodeFragments() machinery.CodeFragmentsMap

GetCodeFragments implements file.Inserter interface.

func (*CmdGenerateSubUpdater) GetIfExistsAction 

func (*CmdGenerateSubUpdater) GetIfExistsAction() machinery.IfExistsAction

GetIfExistsAction implements file.Builder interface.

func (*CmdGenerateSubUpdater) GetMarkers 

func (f *CmdGenerateSubUpdater) GetMarkers() []machinery.Marker

GetMarkers implements file.Inserter interface.

func (*CmdGenerateSubUpdater) GetPath 

func (f *CmdGenerateSubUpdater) GetPath() string

GetPath implements file.Builder interface.

type CmdInit 

type CmdInit struct {
	machinery.TemplateMixin
	machinery.BoilerplateMixin

	// input variables
	Initializer kinds.WorkloadBuilder

	// template variables
	InitCommandName  string
	InitCommandDescr string
}

CmdInit scaffolds the companion CLI's init subcommand for component workloads. The init logic will live in the workload's subcommand to this command; see cmd_init_sub.go.

func (*CmdInit) SetTemplateDefaults 

func (f *CmdInit) SetTemplateDefaults() error

type CmdInitSub 

type CmdInitSub struct {
	machinery.TemplateMixin
	machinery.BoilerplateMixin
	machinery.ResourceMixin
	machinery.RepositoryMixin

	// input fields
	Builder kinds.WorkloadBuilder

	InitCommandName  string
	InitCommandDescr string
	// contains filtered or unexported fields
}

CmdInitSub scaffolds the companion CLI's init subcommand for the workload. This where the actual init logic lives.

func (*CmdInitSub) SetTemplateDefaults 

func (f *CmdInitSub) SetTemplateDefaults() error

type CmdInitSubUpdater 

type CmdInitSubUpdater struct {
	machinery.RepositoryMixin
	machinery.MultiGroupMixin
	machinery.ResourceMixin

	// input fields
	Builder kinds.WorkloadBuilder
	// contains filtered or unexported fields
}

CmdInitSubUpdater updates a specific components init subcommand with appropriate initialization information.

func (*CmdInitSubUpdater) GetCodeFragments 

func (f *CmdInitSubUpdater) GetCodeFragments() machinery.CodeFragmentsMap

GetCodeFragments implements file.Inserter interface.

func (*CmdInitSubUpdater) GetIfExistsAction 

func (*CmdInitSubUpdater) GetIfExistsAction() machinery.IfExistsAction

GetIfExistsAction implements file.Builder interface.

func (*CmdInitSubUpdater) GetMarkers 

func (f *CmdInitSubUpdater) GetMarkers() []machinery.Marker

GetMarkers implements file.Inserter interface.

func (*CmdInitSubUpdater) GetPath 

func (f *CmdInitSubUpdater) GetPath() string

GetPath implements file.Builder interface.

type CmdRoot 

type CmdRoot struct {
	machinery.TemplateMixin
	machinery.BoilerplateMixin
	machinery.RepositoryMixin

	// input variables
	Initializer kinds.WorkloadBuilder

	// template variables
	RootCmd      companion.CLI
	IsCollection bool
}

CmdRoot scaffolds the root command file for the companion CLI.

func (*CmdRoot) SetTemplateDefaults 

func (f *CmdRoot) SetTemplateDefaults() error

type CmdRootUpdater 

type CmdRootUpdater struct {
	machinery.RepositoryMixin
	machinery.MultiGroupMixin
	machinery.ResourceMixin

	// input variables
	Builder         kinds.WorkloadBuilder
	InitCommand     bool
	GenerateCommand bool
	VersionCommand  bool

	// template variables
	RootCmdName string
}

CmdRootUpdater updates root.go to run sub commands.

func (*CmdRootUpdater) GetCodeFragments 

func (f *CmdRootUpdater) GetCodeFragments() machinery.CodeFragmentsMap

GetCodeFragments implements file.Inserter interface.

func (*CmdRootUpdater) GetIfExistsAction 

func (*CmdRootUpdater) GetIfExistsAction() machinery.IfExistsAction

GetIfExistsAction implements file.Builder interface.

func (*CmdRootUpdater) GetMarkers 

func (f *CmdRootUpdater) GetMarkers() []machinery.Marker

GetMarkers implements file.Inserter interface.

func (*CmdRootUpdater) GetPath 

func (f *CmdRootUpdater) GetPath() string

GetPath implements file.Builder interface.

type CmdVersion 

type CmdVersion struct {
	machinery.TemplateMixin
	machinery.BoilerplateMixin

	// input variables
	Initializer kinds.WorkloadBuilder

	// template variables
	VersionCommandName  string
	VersionCommandDescr string
}

CmdVersion scaffolds the companion CLI's version subcommand for component workloads. The version logic will live in the workload's subcommand to this command; see cmd_version_sub.go.

func (*CmdVersion) SetTemplateDefaults 

func (f *CmdVersion) SetTemplateDefaults() error

type CmdVersionSub 

type CmdVersionSub struct {
	machinery.TemplateMixin
	machinery.BoilerplateMixin
	machinery.ResourceMixin
	machinery.RepositoryMixin

	// input fields
	Builder kinds.WorkloadBuilder

	VersionCommandName  string
	VersionCommandDescr string
	// contains filtered or unexported fields
}

CmdVersionSub scaffolds the root command file for the companion CLI.

func (*CmdVersionSub) SetTemplateDefaults 

func (f *CmdVersionSub) SetTemplateDefaults() error

type CmdVersionSubUpdater 

type CmdVersionSubUpdater struct {
	machinery.RepositoryMixin
	machinery.MultiGroupMixin
	machinery.ResourceMixin

	// input fields
	Builder kinds.WorkloadBuilder
	// contains filtered or unexported fields
}

CmdVersionSubUpdater updates a specific components version subcommand with appropriate version information.

func (*CmdVersionSubUpdater) GetCodeFragments 

func (f *CmdVersionSubUpdater) GetCodeFragments() machinery.CodeFragmentsMap

GetCodeFragments implements file.Inserter interface.

func (*CmdVersionSubUpdater) GetIfExistsAction 

func (*CmdVersionSubUpdater) GetIfExistsAction() machinery.IfExistsAction

GetIfExistsAction implements file.Builder interface.

func (*CmdVersionSubUpdater) GetMarkers 

func (f *CmdVersionSubUpdater) GetMarkers() []machinery.Marker

GetMarkers implements file.Inserter interface.

func (*CmdVersionSubUpdater) GetPath 

func (f *CmdVersionSubUpdater) GetPath() string

GetPath implements file.Builder interface.

type Main 

type Main struct {
	machinery.TemplateMixin
	machinery.BoilerplateMixin
	machinery.RepositoryMixin

	RootCmd companion.CLI
}

Main scaffolds the main package for the companion CLI.

func (*Main) GetFuncMap 

func (*Main) GetFuncMap() template.FuncMap

func (*Main) SetTemplateDefaults 

func (f *Main) SetTemplateDefaults() error

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.