edit

Documentation

Overview

Package edit contains sub commands for editing books from the command line.

Index

• Variables
• type DefaultCommand
• type Parser
  • func NewParser(book *books.Book, lib *books.Library, tmpl *template.Template) *Parser
  • func (p *Parser) Completer(s string) []string
  • func (p *Parser) RunCommand(cmd string, args string) error

Variables

var ErrUnknownCommand = errors.New("unknown command")

ErrUnknownCommand is returned when a command cannot be found by the given command name.

Types

type DefaultCommand

type DefaultCommand struct {
	Run  func(cmd *DefaultCommand, args string)
	RunE func(cmd *DefaultCommand, args string) error
	Help string
	// contains filtered or unexported fields
}

DefaultCommand contains fields used by all other edit commands.

type Parser

type Parser struct {
	OutputTemplate *template.Template
	// contains filtered or unexported fields
}

Parser contains the set of available commands, and the shared state for those commands.

func NewParser

func NewParser(book *books.Book, lib *books.Library, tmpl *template.Template) *Parser

NewParser creates a new parser.

func (*Parser) Completer

func (p *Parser) Completer(s string) []string

Completer tries to complete a command and its arguments.

func (*Parser) RunCommand

func (p *Parser) RunCommand(cmd string, args string) error

RunCommand runs a command with the given arguments, returning ErrUnknownCommand if not found.