@kjanat/dreamcli/testkit

Test utilities for running commands in-process.

import {
  ,
  ,
  ,
  ,
  ,
} from '@kjanat/dreamcli/testkit';

runCommand(command, argv, options?)

Run a command in-process and return a RunResult.

import {  } from '@kjanat/dreamcli/testkit';

const  = await (, ['Alice', '--loud']);

Parameters

Parameter	Type	Description
command	CommandBuilder	The command to run
argv	string[]	Simulated command-line arguments
options	RunOptions	Optional configuration

RunOptions

Option	Type	Description
env	Record<string, string | undefined>	Environment variables
config	Record<string, unknown>	Config file values
stdinData	string | null	Data to pipe to process stdin for tests
answers	unknown[]	Prompt answers in order
prompter	PromptEngine	Custom prompt handler
jsonMode	boolean	Simulate --json mode
help	HelpOptions	Help formatting options
verbosity	Verbosity	Output verbosity
isTTY	boolean	Simulate TTY connection

RunResult

Field	Type	Description
exitCode	number	Process exit code
stdout	string[]	Captured stdout lines
stderr	string[]	Captured stderr lines
error	CLIError | undefined	Structured error, undefined on success
activity	ActivityEvent[]	Spinner/progress events

createCaptureOutput()

Create an output channel that captures all writes for assertions.

createTestPrompter(answers)

Create a prompt engine that returns pre-defined answers.

import {  } from '@kjanat/dreamcli/testkit';

const  = ([
  'eu',
  true,
  'my-name',
]);

createTestAdapter(options?)

Returns a runtime adapter for testing (no real process access).

PROMPT_CANCEL

Sentinel value to simulate prompt cancellation.

import {
  ,
  ,
  ,
} from '@kjanat/dreamcli/testkit';

const  = await (, [], {
  : ([]),
});