cmd

README

cmd

Run and organize code snippets in markdown files

docs:update-demos

docker run -it --rm -v $(pwd)/demos:/demos $(docker build -q -f ./record-demo.Dockerfile .) /demos/record-script.sh /demos/intro/intro.script /demos/intro/intro.cast
docker run -it --rm -v $(pwd)/demos:/demos $(docker build -q -f ./record-demo.Dockerfile .) asciinema upload /demos/intro/intro.cast

code:test

go test ./...

Documentation

Index

• Constants
• Variables
• func UpWhere(initialDir, marker string) (string, error)
• type Command
  • func ParseCommands(source []byte) ([]*Command, error)
  • func (c *Command) Check(ctx context.Context) (string, error)
  • func (c *Command) Execute(ctx context.Context, f *flag.FlagSet, args ...interface{}) subcommands.ExitStatus
  • func (c *Command) Name() string
  • func (c *Command) SetFlags(f *flag.FlagSet)
  • func (c *Command) Synopsis() string
  • func (c *Command) Usage() string
• type CommandDefinition
  • func ParseCommandDefinitions(source []byte) ([]CommandDefinition, error)
  • func (d *CommandDefinition) Parse() (*Command, error)
  • func (d *CommandDefinition) ParseCommand() string
  • func (d *CommandDefinition) ParseDefinition() string
  • func (d *CommandDefinition) ParseHelp() string
  • func (d *CommandDefinition) ParseInfo() (string, map[string]string)
• type ShellCommand
  • func NewShellCommand(shell string) (*ShellCommand, error)
  • func (c *ShellCommand) Print() (string, error)
  • func (c *ShellCommand) Render(locals map[string]*ShellValue) (string, error)
• type ShellValue

Constants

const DefaultLanguage = "bash"

Variables

var BuildID string = "unknown"

Functions

func UpWhere

func UpWhere(initialDir, marker string) (string, error)

Types

type Command

type Command struct {
	Alias string
	Group string

	Help       string
	Definition string

	RenderCheckCmd func(ctx context.Context) *exec.Cmd

	SetExecFlags  func(f *flag.FlagSet)
	RenderExecCmd func(ctx context.Context, f *flag.FlagSet, args ...interface{}) (*exec.Cmd, error)
}

func ParseCommands

func ParseCommands(source []byte) ([]*Command, error)

func (*Command) Check

func (c *Command) Check(ctx context.Context) (string, error)

func (*Command) Execute

func (c *Command) Execute(ctx context.Context, f *flag.FlagSet, args ...interface{}) subcommands.ExitStatus

func (*Command) Name

func (c *Command) Name() string

func (*Command) SetFlags

func (c *Command) SetFlags(f *flag.FlagSet)

func (*Command) Synopsis

func (c *Command) Synopsis() string

func (*Command) Usage

func (c *Command) Usage() string

type CommandDefinition

type CommandDefinition struct {
	InputPath            string
	DeclaretionLineStart int

	Source           []byte
	Name             string
	HeadingStart     int
	HeadingStop      int
	HelpStart        int
	HelpStop         int
	DeclarationStart int
	DeclarationStop  int
	Declaration      *mdast.FencedCodeBlock
}

func ParseCommandDefinitions

func ParseCommandDefinitions(source []byte) ([]CommandDefinition, error)

func (*CommandDefinition) Parse

func (d *CommandDefinition) Parse() (*Command, error)

func (*CommandDefinition) ParseCommand

func (d *CommandDefinition) ParseCommand() string

func (*CommandDefinition) ParseDefinition

func (d *CommandDefinition) ParseDefinition() string

func (*CommandDefinition) ParseHelp

func (d *CommandDefinition) ParseHelp() string

func (*CommandDefinition) ParseInfo

func (d *CommandDefinition) ParseInfo() (string, map[string]string)

type ShellCommand

type ShellCommand struct {
	Exports map[string]*ShellValue
	Locals  map[string]*ShellValue

	LocalDeclarations map[string]*syntax.ParamExp

	File *syntax.File
}

func NewShellCommand

func NewShellCommand(shell string) (*ShellCommand, error)

func (*ShellCommand) Print

func (c *ShellCommand) Print() (string, error)

func (*ShellCommand) Render

func (c *ShellCommand) Render(locals map[string]*ShellValue) (string, error)

type ShellValue

type ShellValue struct {
	Literal    string
	Expression string
}