cmd

Documentation

Index

• Variables
• func Execute()
• type License
• type Project
  • func NewProject(projectName string) *Project
  • func NewProjectFromPath(absPath string) *Project
  • func (p Project) AbsPath() string
  • func (p *Project) CmdPath() string
  • func (p *Project) License() License
  • func (p Project) Name() string
  • func (p *Project) SrcPath() string

Variables

var Licenses = make(map[string]License)

Licenses contains all possible licenses a user can choose from.

Functions

func Execute

func Execute()

Execute executes the root command.

Types

type License

type License struct {
	Name            string   // The type of license in use
	PossibleMatches []string // Similar names to guess
	Text            string   // License text data
	Header          string   // License header for source files
}

License represents a software license agreement, containing the Name of the license, its possible matches (on the command line as given to cobra), the header to be used with each file on the file's creating, and the text of the license

type Project

type Project struct {
	// contains filtered or unexported fields
}

Project contains name, license and paths to projects.

func NewProject

func NewProject(projectName string) *Project

NewProject returns Project with specified project name. If projectName is blank string, it returns nil.

func NewProjectFromPath

func NewProjectFromPath(absPath string) *Project

NewProjectFromPath returns Project with specified absolute path to package. If absPath is blank string or if absPath is not actually absolute, it returns nil.

func (Project) AbsPath

func (p Project) AbsPath() string

AbsPath returns absolute path of project.

func (*Project) CmdPath

func (p *Project) CmdPath() string

CmdPath returns absolute path to directory, where all commands are located.

CmdPath returns blank string, only if p.AbsPath() is a blank string.

func (*Project) License

func (p *Project) License() License

License returns the License object of project.

func (Project) Name

func (p Project) Name() string

Name returns the name of project, e.g. "github.com/spf13/cobra"

func (*Project) SrcPath

func (p *Project) SrcPath() string

SrcPath returns absolute path to $GOPATH/src where project is located.