type alias Guide

Everything one guidance screen says.

Properties

readonly
optional
header: string

First line, echoing the resolved specifier so shorthand is never invisible.

readonly
optional
diagnostic: boolean

Whether the screen reports a failure rather than disclosing the next word.

A pure disclosure level is guidance: --help may relocate it to stdout and exit 0. A diagnostic — an unreadable package, a misspelled coder, a listing that could not be produced — is a failure that happens to be explained well, and stays on stderr with a non-zero exit whatever the flags say, so that binstruct nosuchpkg --help > out.txt cannot report success.

readonly
optional
notes: readonly string[]

Lines shown before NEXT: what went wrong, or what was inferred.

readonly
next: GuideNext

The missing word.

The values that word may take.

readonly
optional
try: readonly string[]

Paste-ready commands one step further along.

Usage

import { type Guide } from "mod.ts";