Skip to content

RenderContextOptions

Inputs for resolveRenderContext. Pass the host facts (TTY status, environment) and any explicit overrides; the resolver applies the same gating .execute()/.run() feed into the output channel.

Signatures

ts
interface RenderContextOptions {}

Members

Properties

builtins

Which built-in flags the CLI still owns, matching its .builtins() call. A built-in set to 'off' is not read out of argv here either.

ts
builtins?: BuiltinsConfig;

color

Explicitly enable or disable colors, winning over the auto-gate.

ts
color?: boolean;

env

Environment variables consulted for NO_HYPERLINKS/FORCE_HYPERLINKS (e.g. process.env).

ts
env?: Readonly<Record<string, string | undefined>>;

isTTY

Whether stdout is connected to a TTY (e.g. process.stdout.isTTY).

ts
isTTY?: boolean;

jsonMode

JSON mode when argv carries no root --json. An explicit --json=false in argv wins over this.

ts
jsonMode?: boolean;

verbosity

Output verbosity when argv carries no root --quiet/-q. An explicit --quiet=false in argv wins over this.

ts
verbosity?: "normal" | "quiet";

See Also

Released under the MIT License.