asciicast

type Event struct {
	Time   float64
	Stream string
	Data   string
}

type ExecOptions struct {
	// Command is the argv to run; Command[0] is resolved via PATH.
	Command []string
	// Dir is the working directory for the command (empty = inherit).
	Dir string
	// Env is the full environment for the command (nil = inherit).
	Env []string
	// Path is the output .cast file path.
	Path string
	// Width and Height size the recorded terminal (0 = defaults).
	Width  int
	Height int
	// Title is an optional cast title.
	Title string
}

type ExecResult struct {
	// ExitCode is the command's exit status (0 on success).
	ExitCode int
}

type Header struct {
	Version   int               `json:"version"`
	Width     int               `json:"width,omitempty"`
	Height    int               `json:"height,omitempty"`
	Term      *Term             `json:"term,omitempty"`
	Timestamp int64             `json:"timestamp,omitempty"`
	Title     string            `json:"title,omitempty"`
	Command   string            `json:"command,omitempty"`
	Env       map[string]string `json:"env,omitempty"`
}

type Options struct {
	Path       string
	BasePath   string
	Name       string
	Title      string
	Command    []string
	Width      int
	Height     int
	RecordIn   bool
	Explicit   bool
	Overwrite  bool
	Env        map[string]string
	Now        func() time.Time
	Executable string
	OutputRate time.Duration
}

type Recorder struct {
	// contains filtered or unexported fields
}

type RenderOptions struct {
	GIF   string
	MP4   string
	HTML  string
	ASCII string
	PNG   string
	JPEG  string
}

type SessionAction struct {
	Type     string
	Text     string
	Regex    string
	Key      string
	Duration string
	Timeout  string
	Rate     string
	Interval string
	Repeat   int
	Actions  []SessionAction
	// Fn runs a caller-supplied action (Type == "simulate") in place, letting
	// a session mix in the same styled, non-interactive narration steps
	// mode: steps uses (see pkg/runner/step's simulate rendering) instead of
	// typing raw, unstyled keystrokes for comment/narration lines. asciicast
	// deliberately has no styling logic of its own; the caller renders and
	// writes the styled bytes itself, and this callback is how a session
	// action list carries that back out to it in order.
	Fn func() error
}

type SessionOptions struct {
	Shell       string
	Dir         string
	Env         map[string]string
	Width       int
	Height      int
	WriteRate   time.Duration
	KeyInterval time.Duration
	Actions     []SessionAction
	Recorder    *Recorder
}

type Term struct {
	Cols int    `json:"cols"`
	Rows int    `json:"rows"`
	Type string `json:"type,omitempty"`
}