cli

Documentation

Overview

Package cli defines the command-line features of conch.

Index

• func GetFileContents(filename string) (string, error)
• func Template(name string, contents string) (*template.Template, error)
• type Filters
  • func (f *Filters) Any() bool
• type Outputs
  • func (o *Outputs) Any() bool
• type Selections
  • func (s *Selections) Any() bool

Functions

func GetFileContents

func GetFileContents(filename string) (string, error)

GetFileContents reads the entire contents of a text file into a string.

func Template

func Template(name string, contents string) (*template.Template, error)

Template creates a new text template with the specified name and contents, suitable for formatting CLI output.

Types

type Filters

type Filters struct {
	Types  util.CaseInsensitiveSet
	Scopes util.CaseInsensitiveSet
	Selections
}

Filters are the different ways commits can be included based on their attributes or impact.

func (*Filters) Any

func (f *Filters) Any() bool

type Outputs

type Outputs struct {
	List        bool
	Format      string
	Count       bool
	Impact      bool
	BumpVersion string
}

Outputs are the different ways that commit information can be displayed to the user on the command line.

func (*Outputs) Any

func (o *Outputs) Any() bool

type Selections

type Selections struct {
	Breaking      bool
	Minor         bool
	Patch         bool
	Uncategorized bool
}

Selections are the different ways commits can be included based on impact.

func (*Selections) Any

func (s *Selections) Any() bool