base

Documentation

Overview

Package base defines shared basic pieces of the igop command, in particular logging and the Command structure.

Index

• Variables
• func Main(c *Command, app string, args []string)
• type Command
  • func (c *Command) LongName() string
  • func (c *Command) Name() string
  • func (c *Command) Runnable() bool
  • func (c *Command) Usage(w io.Writer)

Variables

var CmdName string

CmdName - "build", "install", "list", "mod tidy", etc.

var Igop = &Command{
	UsageLine: "igop",
	Short:     `igop is a tool for managing Go source code.`,
}

Igop command

var Usage func()

Usage is the usage-reporting function, filled in by package main but here for reference by other packages.

Functions

func Main

func Main(c *Command, app string, args []string)

Main runs a command.

Types

type Command

type Command struct {
	// Run runs the command.
	// The args are the arguments after the command name.
	Run func(cmd *Command, args []string)

	// UsageLine is the one-line usage message.
	// The words between "igop" and the first flag or argument in the line are taken to be the command name.
	UsageLine string

	// Short is the short description shown in the 'igop help' output.
	Short string

	// Flag is a set of flags specific to this command.
	Flag flag.FlagSet

	// Commands lists the available commands and help topics.
	// The order here is the order in which they are printed by 'igop help'.
	// Note that subcommands are in general best avoided.
	Commands []*Command
}

A Command is an implementation of a igop command like igop export or igop install.

func (*Command) LongName

func (c *Command) LongName() string

LongName returns the command's long name: all the words in the usage line between "igop" and a flag or argument,

func (*Command) Name

func (c *Command) Name() string

Name returns the command's short name: the last word in the usage line before a flag or argument.

func (*Command) Runnable

func (c *Command) Runnable() bool

Runnable reports whether the command can be run; otherwise it is a documentation pseudo-command.

func (*Command) Usage

func (c *Command) Usage(w io.Writer)

Usage show the command usage.