command

Documentation

Index

• Constants
• Variables
• func ChecksumForCmdPersisted(dotLetsDir string, cmdName string) bool
• func EvalEnvVariable(rawCmd string) (string, error)
• func OptsToLetsCli(opts docopt.Opts) map[string]string
• func OptsToLetsOpt(opts docopt.Opts) map[string]string
• func ParseAndValidateCommand(newCmd *Command, rawCommand map[interface{}]interface{}) error
• func ParseDocopts(args []string, rawOptions string) (docopt.Opts, error)
• func PersistCommandsChecksumToDisk(dotLetsDir string, cmd Command) error
• type Command
  • func NewCommand(name string) Command
  • func (cmd *Command) ChecksumCalculator(workDir string) error
  • func (cmd *Command) GetPersistedChecksums() map[string]string
  • func (cmd *Command) ReadChecksumsFromDisk(dotLetsDir string, cmdName string, checksumMap map[string]string) error
• type ParseCommandError
  • func (e *ParseCommandError) Error() string

Constants

const DefaultChecksumName = "lets_default_checksum"

Variables

var (
	CMD             = "cmd"
	DESCRIPTION     = "description"
	ENV             = "env"
	EvalEnv         = "eval_env"
	OPTIONS         = "options"
	DEPENDS         = "depends"
	CHECKSUM        = "checksum"
	PersistChecksum = "persist_checksum"
)

var DocoptParser = &docopt.Parser{
	HelpHandler:   docopt.NoHelpHandler,
	OptionsFirst:  false,
	SkipHelpFlags: false,
}

Functions

func ChecksumForCmdPersisted

func ChecksumForCmdPersisted(dotLetsDir string, cmdName string) bool

ChecksumForCmdPersisted checks if checksums for cmd exists and persisted

func EvalEnvVariable

func EvalEnvVariable(rawCmd string) (string, error)

eval env value and trim result string TODO pass env from cfg.env - it will allow to use static env in eval_env TODO maybe use cfg.Shell instead of sh

func OptsToLetsCli

func OptsToLetsCli(opts docopt.Opts) map[string]string

func OptsToLetsOpt

func OptsToLetsOpt(opts docopt.Opts) map[string]string

func ParseAndValidateCommand

func ParseAndValidateCommand(newCmd *Command, rawCommand map[interface{}]interface{}) error

ParseAndValidateCommand parses and validates unmarshaled yaml

func ParseDocopts

func ParseDocopts(args []string, rawOptions string) (docopt.Opts, error)

ParseDocopts parses docopts for command options with args from os.Args TODO pass os.Argv explicitly

func PersistCommandsChecksumToDisk

func PersistCommandsChecksumToDisk(dotLetsDir string, cmd Command) error

Types

type Command

type Command struct {
	Name string
	// script to run
	Cmd string
	// map of named scripts to run in parallel
	CmdMap      map[string]string
	Description string
	// env from command
	Env map[string]string
	// env from -E flag
	OverrideEnv     map[string]string
	RawOptions      string
	Options         map[string]string
	CliOptions      map[string]string
	Depends         []string
	Checksum        string
	ChecksumMap     map[string]string
	PersistChecksum bool

	// prepared args - started from command name
	Args []string

	// run only specified commands from cmd map
	Only []string
	// run all but excluded commands from cmd map
	Exclude []string
	// contains filtered or unexported fields
}

func NewCommand

func NewCommand(name string) Command

NewCommand creates new command struct

func (*Command) ChecksumCalculator

func (cmd *Command) ChecksumCalculator(workDir string) error

func (*Command) GetPersistedChecksums

func (cmd *Command) GetPersistedChecksums() map[string]string

func (*Command) ReadChecksumsFromDisk

func (cmd *Command) ReadChecksumsFromDisk(dotLetsDir string, cmdName string, checksumMap map[string]string) error

ReadChecksumsFromDisk reads all checksums for cmd into map

type ParseCommandError

type ParseCommandError struct {
	Name string
	Path struct {
		Full  string
		Field string
	}
	Err error
}

func (*ParseCommandError) Error

func (e *ParseCommandError) Error() string