cmd

Documentation

Overview

Package cmd handles the terminal interface, user flags and arguments.

Index

• Variables
• func Execute() error
• func InfoCommand() *cobra.Command
• func InfoInit() *cobra.Command
• func Init()
• func ListCodepages() *cobra.Command
• func ListCommand() *cobra.Command
• func ListExamples() *cobra.Command
• func ListInit() *cobra.Command
• func ListTable() *cobra.Command
• func ListTables() *cobra.Command
• func Tester(c *cobra.Command) *cobra.Command
• func ViewCommand() *cobra.Command
• func ViewInit() *cobra.Command
• type Lists
  • func (l Lists) Command() *cobra.Command

Variables

var (
	ErrHide  = errors.New("could not hide the flag")
	ErrUsage = errors.New("command usage could not display")
)

var Cmd = &cobra.Command{
	Use:   meta.Bin,
	Short: fmt.Sprintf("Use %s to print plain, BBS era and ANSI textfiles", meta.Name),
	Long: meta.Name + " takes legacy codepage and ANSI encoded textfiles and\n" +
		"prints them to a modern Unicode terminal.",
	Example: fmt.Sprint(example.Cmd),
	RunE: func(cmd *cobra.Command, args []string) error {

		return flag.Help(cmd)
	},
}

Cmd represents the base command when called without any subcommands.

Functions

func Execute

func Execute() error

Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.

func InfoCommand

func InfoCommand() *cobra.Command

func InfoInit

func InfoInit() *cobra.Command

func Init

func Init()

func ListCodepages

func ListCodepages() *cobra.Command

func ListCommand

func ListCommand() *cobra.Command

func ListExamples

func ListExamples() *cobra.Command

func ListInit

func ListInit() *cobra.Command

func ListTable

func ListTable() *cobra.Command

func ListTables

func ListTables() *cobra.Command

func Tester

func Tester(c *cobra.Command) *cobra.Command

Tester creates and hides a custom tester flag. It is its own function so it can also be applied to unit tests as well as init.

func ViewCommand

func ViewCommand() *cobra.Command

func ViewInit

func ViewInit() *cobra.Command

Types

type Lists

type Lists int

Lists are the subcommands of the list command.

const (
	Codepages Lists = iota // Codepages list command.
	Examples               // Examples list command.
	Table                  // Table command lists a single table.
	Tables                 // Tables command lists all tables.
)

func (Lists) Command

func (l Lists) Command() *cobra.Command

Command runs one of the list subcommands.