doclint

type CommandRunner func(context.Context, string, []string, string, []string) (string, error)

type FlagRef struct {
	DocPath string
	Line    int
	Flag    string
}

type GoBlock struct {
	DocPath string // repo-relative path of the Markdown file
	Line    int    // 1-based line of the block's opening fence
	Source  string // the block's Go source
	// Compile is true when the opening fence is marked `gwc:build` — an opt-in that the sample
	// is a complete, runnable program to be type-checked (compiled), not just parsed. Native is
	// true for the `gwc:build:native` variant (a server/native sample); otherwise the sample is
	// compiled for the browser (js/wasm) target.
	Compile bool
	Native  bool
}

type GoBlockCompileError struct {
	DocPath string
	Line    int
	Err     string
}

type GoBlockError struct {
	DocPath string
	Line    int
	Err     string
}

type GwcCommandPlan struct {
	Ref        GwcCommandRef
	Args       []string
	SkipReason string
}

type GwcCommandRef struct {
	DocPath string
	Line    int
	Raw     string
	Args    []string
}

type GwcCommandResult struct {
	Plan   GwcCommandPlan
	Output string
	Err    error
}

type GwcCommandRunOptions struct {
	OutputRoot  string
	Timeout     time.Duration
	MaxCommands int
	Runner      CommandRunner
}

type GwcCommandRunSummary struct {
	Executed []GwcCommandResult
	Skipped  []GwcCommandResult
}

type PathRef struct {
	// DocPath is the repo-relative path of the Markdown file that contains it.
	DocPath string
	// Line is the 1-based line number of the reference within that file.
	Line int
	// Raw is the token exactly as written in the doc (Windows or POSIX style).
	Raw string
	// Rel is the normalized, forward-slash, repo-relative path to resolve.
	Rel string
}