cmd

Documentation

Index

• func RootCmd() *cobra.Command
• type Batch
  • func NewBatch(timeNow core.TimeNow, templateCache *core.TemplateCache) *Batch
  • func (b *Batch) ClearUnreleased(changes []core.Change, otherFiles ...string) error
  • func (b *Batch) Run(cmd *cobra.Command, args []string) (err error)
  • func (b *Batch) WriteChanges(changes []core.Change) error
  • func (b *Batch) WriteTemplate(template string, beforeNewlines int, afterNewlines int, templateData any) error
  • func (b *Batch) WriteTemplateFile(relativePath string, beforeNewlines int, afterNewlines int, templateData any) error
• type CoreTypes
• type FieldProps
• type Gen
  • func NewGen() *Gen
  • func (g *Gen) Run(cmd *cobra.Command, args []string) error
• type Init
  • func NewInit() *Init
  • func (i *Init) Run(cmd *cobra.Command, args []string) error
• type Latest
  • func NewLatest() *Latest
  • func (l *Latest) Run(cmd *cobra.Command, args []string) error
• type Merge
  • func NewMerge(templateCache *core.TemplateCache) *Merge
  • func (m *Merge) Run(cmd *cobra.Command, args []string) error
• type New
  • func NewNew(timeNow core.TimeNow, templateCache *core.TemplateCache) *New
  • func (n *New) Run(cmd *cobra.Command, args []string) error
• type Next
  • func NewNext() *Next
  • func (n *Next) Run(cmd *cobra.Command, args []string) error
• type TypeProps

Functions

func RootCmd

func RootCmd() *cobra.Command

rootCmd represents the base command when called without any subcommands

Types

type Batch

type Batch struct {
	*cobra.Command

	// CLI args
	OldHeaderPath     string // deprecated but still supported until 2.0
	VersionHeaderPath string
	VersionFooterPath string
	KeepFragments     bool
	RemovePrereleases bool
	Project           string
	MoveDir           string
	IncludeDirs       []string
	DryRun            bool
	Prerelease        []string
	Meta              []string
	Force             bool

	// Dependencies
	TimeNow       core.TimeNow
	TemplateCache *core.TemplateCache
	// contains filtered or unexported fields
}

func NewBatch

func NewBatch(
	timeNow core.TimeNow,
	templateCache *core.TemplateCache,
) *Batch

func (*Batch) ClearUnreleased

func (b *Batch) ClearUnreleased(changes []core.Change, otherFiles ...string) error

func (*Batch) Run

func (b *Batch) Run(cmd *cobra.Command, args []string) (err error)

func (*Batch) WriteChanges

func (b *Batch) WriteChanges(changes []core.Change) error

func (*Batch) WriteTemplate

func (b *Batch) WriteTemplate(
	template string,
	beforeNewlines int,
	afterNewlines int,
	templateData any,
) error

func (*Batch) WriteTemplateFile

func (b *Batch) WriteTemplateFile(
	relativePath string,
	beforeNewlines int,
	afterNewlines int,
	templateData any,
) error

type CoreTypes

type CoreTypes map[string]*godoc.Type

type FieldProps

type FieldProps struct {
	Name             string
	TypeName         string
	Doc              string
	File             string
	Line             int
	Key              string
	MapKeyTypeName   string
	MapValueTypeName string
	ExampleLang      string
	ExampleContent   string
	TemplateType     string
	IsCustomType     bool
	Required         bool
	Slice            bool
}

type Gen

type Gen struct {
	*cobra.Command
}

func NewGen

func NewGen() *Gen

func (*Gen) Run

func (g *Gen) Run(cmd *cobra.Command, args []string) error

type Init

type Init struct {
	*cobra.Command

	// CLI args
	ChangesDir    string
	ChangelogPath string
	Force         bool
}

func NewInit

func NewInit() *Init

func (*Init) Run

func (i *Init) Run(cmd *cobra.Command, args []string) error

type Latest

type Latest struct {
	*cobra.Command

	// CLI args
	RemovePrefix    bool
	SkipPrereleases bool
	Project         string
}

func NewLatest

func NewLatest() *Latest

func (*Latest) Run

func (l *Latest) Run(cmd *cobra.Command, args []string) error

type Merge

type Merge struct {
	*cobra.Command

	// cli args
	DryRun           bool
	UnreleasedHeader string

	// dependencies
	TemplateCache *core.TemplateCache
}

func NewMerge

func NewMerge(templateCache *core.TemplateCache) *Merge

func (*Merge) Run

func (m *Merge) Run(cmd *cobra.Command, args []string) error

type New

type New struct {
	*cobra.Command

	// cli args
	DryRun     bool
	Projects   []string
	Component  string
	Kind       string
	Body       string
	BodyEditor bool
	Custom     []string

	// dependencies
	TimeNow       core.TimeNow
	TemplateCache *core.TemplateCache
}

func NewNew

func NewNew(
	timeNow core.TimeNow,
	templateCache *core.TemplateCache,
) *New

func (*New) Run

func (n *New) Run(cmd *cobra.Command, args []string) error

type Next

type Next struct {
	*cobra.Command

	// cli args
	IncludeDirs []string
	Prerelease  []string
	Meta        []string
	Project     string
}

func NewNext

func NewNext() *Next

func (*Next) Run

func (n *Next) Run(cmd *cobra.Command, args []string) error

type TypeProps

type TypeProps struct {
	Name           string
	Doc            string
	File           string
	Line           int
	ExampleLang    string
	ExampleContent string
	Fields         []FieldProps
}