model

package
v0.0.20 Latest Latest
Warning

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

Go to latest
Published: Feb 18, 2026 License: BSD-3-Clause Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Command

type Command struct {
	*DataModel
	MainCmdName        string
	SubCommands        []*SubCommand
	PackagePath        string
	ImportPath         string
	CommandPackageName string
	Description        string
	ExtendedHelp       string
	FunctionName       string
	DefinitionFile     string
	DocStart           token.Pos
	DocEnd             token.Pos
	Parameters         []*FunctionParameter
	ReturnsError       bool
	ReturnCount        int
}

type DataModel

type DataModel struct {
	FileSet     *token.FileSet
	PackageName string
	Commands    []*Command
}

type FunctionParameter

type FunctionParameter struct {
	Name               string
	Type               string
	FlagAliases        []string
	Default            string
	Description        string
	IsPositional       bool
	PositionalArgIndex int
	IsVarArg           bool
	VarArgMin          int
	VarArgMax          int
}

func (*FunctionParameter) DefaultString added in v0.0.20

func (p *FunctionParameter) DefaultString() string

func (*FunctionParameter) FlagString

func (p *FunctionParameter) FlagString() string

type SubCommand

type SubCommand struct {
	*Command
	Parent                 *SubCommand
	SubCommands            []*SubCommand
	SubCommandName         string
	SubCommandStructName   string
	SubCommandFunctionName string
	SubCommandDescription  string
	SubCommandExtendedHelp string
	ImportPath             string
	SubCommandPackageName  string
	UsageFileName          string
	DefinitionFile         string
	DocStart               token.Pos
	DocEnd                 token.Pos
	Parameters             []*FunctionParameter
	ReturnsError           bool
	ReturnCount            int
}

func (*SubCommand) HasSubcommands

func (sc *SubCommand) HasSubcommands() bool

func (*SubCommand) MaxDefaultLength added in v0.0.20

func (sc *SubCommand) MaxDefaultLength() int

func (*SubCommand) MaxFlagLength

func (sc *SubCommand) MaxFlagLength() int

func (*SubCommand) ParentCmdName

func (sc *SubCommand) ParentCmdName() string

func (*SubCommand) ProgName

func (sc *SubCommand) ProgName() string

func (*SubCommand) SubCommandSequence

func (sc *SubCommand) SubCommandSequence() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL