rundown

Documentation

Index

• Constants
• Variables
• func DetectErrorLine(filename string, stdout string) (int, bool)
• func ValidateModifiers(subject *markdown.Modifiers) []error
• type ExecutionResult
• type StopError
  • func (e *StopError) Error() string

Constants

const (
	NoSpinFlag        markdown.Flag = "nospin"
	InteractiveFlag                 = "interactive"
	SkipOnSuccessFlag               = "skip-on-success"
	SkipOnFailureFlag               = "skip-on-failure"
	StdoutFlag                      = "stdout"
	StderrFlag                      = "stderr"
	RevealFlag                      = "reveal"
	NoRunFlag                       = "norun"
	NamedFlag                       = "named"
	NamedAllFlag                    = "named-all"
	CaptureEnvFlag                  = "env"
	StopOkFlag                      = "stop-ok"
	StopFailFlag                    = "stop-fail"
	IgnoreFailureFlag               = "ignore-failure"
	EnvAwareFlag                    = "sub-env"
	SetupFlag                       = "setup"
	BorgFlag                        = "borg"
	DescriptionFlag                 = "desc"
	OnFailureFlag                   = "on-failure"
)

const (
	SaveParameter        markdown.Parameter = "save"
	WithParameter                           = "with"
	LabelParameter                          = "label"
	DescriptionParameter                    = "desc"
	OnFailureParameter                      = "on-failure"
	StopFailParameter                       = "stop-fail"
)

Variables

var (
	SuccessfulExecution = ExecutionResult{Kind: "Success", IsError: false, FocusLine: -1}
	SkipToNextHeading   = ExecutionResult{Kind: "Skip", IsError: false, FocusLine: -1}
	StopFailResult      = ExecutionResult{Kind: "Stop", IsError: true, FocusLine: -1}
	StopOkResult        = ExecutionResult{Kind: "Stop", IsError: false, FocusLine: -1}
)

Functions

func DetectErrorLine

func DetectErrorLine(filename string, stdout string) (int, bool)

Attempts to detect the actual line in the script which an error refers to.

func ValidateModifiers

func ValidateModifiers(subject *markdown.Modifiers) []error

Types

type ExecutionResult

type ExecutionResult struct {
	Message   string
	Kind      string
	Source    string
	Output    string
	IsError   bool
	FocusLine int
}

type StopError

type StopError struct {
	Result       ExecutionResult
	StopHandlers *markdown.Container
}

func (*StopError) Error

func (e *StopError) Error() string