@clutchify/bullet-terminal
Type Aliases
BuildStatus
BuildStatus =
"idle"|"compiling"|"ok"|"error"
Build compilation state for a single project.
CreateTuiOptions
CreateTuiOptions =
object
Options passed to createTui.
Properties
| Property | Type |
|---|---|
actions | TuiActions |
projects | TuiProject[] |
LogChannel
LogChannel =
object
Methods for appending log lines at different severity levels.
Properties
| Property | Type |
|---|---|
error | (message) => void |
info | (message) => void |
raw | (message) => void |
warn | (message) => void |
LogLevel
LogLevel =
"info"|"warn"|"error"|"raw"
Log severity level. "raw" is for pre-formatted output that bypasses level formatting.
ProjectKind
ProjectKind =
"web"|"react-native"
Denotes whether a project targets a browser or a React Native runtime.
TuiActions
TuiActions =
object
Keyboard action callbacks wired to shortcuts in the TUI dashboard.
Properties
| Property | Type |
|---|---|
openDebugger | (project) => void |
openDevMenu | (project) => void |
reload | (project) => void |
TuiHandle
TuiHandle =
object
Handle returned by createTui for logging and status updates.
Properties
| Property | Type | Description |
|---|---|---|
channel | (project) => LogChannel | Returns a log channel for the given project name. |
destroy | () => Promise<void> | Tears down the TUI and resolves when it has fully exited. |
setStatus | (project, status) => void | Updates the compilation status indicator for a project. |
TuiProject
TuiProject =
object
A single project entry in the TUI dashboard.
Properties
| Property | Type | Description |
|---|---|---|
kind | ProjectKind | - |
name | string | Rspack configuration name (e.g. "client", "android"). |
Functions
createTui()
createTui(
options):Promise<TuiHandle>
Boots the terminal dashboard for a dev-server process: one vertical tab per rspack
configuration (client, server, android, ios), showing that project's logs when
focused, with React Native reload/dev-menu/debugger shortcuts on native tabs.
Intended to be invoked from the bullet adapter plugin when development.tui !== false and
stdout is a TTY. Callers must call destroy() on shutdown to restore the terminal.
Parameters
| Parameter | Type |
|---|---|
options | CreateTuiOptions |
Returns
Promise<TuiHandle>