Repository navigation
Expand file tree
/
Copy pathroot.ts
More file actions
184 lines (165 loc) · 4.49 KB
/
Copy pathroot.ts
File metadata and controls
184 lines (165 loc) · 4.49 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
import type { ReactNode } from 'react'
import { logForDebugging } from 'src/utils/debug.js'
import { Stream } from 'stream'
import type { FrameEvent } from './frame.js'
import Ink, { type Options as InkOptions } from './ink.js'
import instances from './instances.js'
export type RenderOptions = {
/**
* Output stream where app will be rendered.
*
* @default process.stdout
*/
stdout?: NodeJS.WriteStream
/**
* Input stream where app will listen for input.
*
* @default process.stdin
*/
stdin?: NodeJS.ReadStream
/**
* Error stream.
* @default process.stderr
*/
stderr?: NodeJS.WriteStream
/**
* Configure whether Ink should listen to Ctrl+C keyboard input and exit the app. This is needed in case `process.stdin` is in raw mode, because then Ctrl+C is ignored by default and process is expected to handle it manually.
*
* @default true
*/
exitOnCtrlC?: boolean
/**
* Patch console methods to ensure console output doesn't mix with Ink output.
*
* @default true
*/
patchConsole?: boolean
/**
* Called after each frame render with timing and flicker information.
*/
onFrame?: (event: FrameEvent) => void
}
export type Instance = {
/**
* Replace previous root node with a new one or update props of the current root node.
*/
rerender: Ink['render']
/**
* Manually unmount the whole Ink app.
*/
unmount: Ink['unmount']
/**
* Returns a promise, which resolves when app is unmounted.
*/
waitUntilExit: Ink['waitUntilExit']
cleanup: () => void
}
/**
* A managed Ink root, similar to react-dom's createRoot API.
* Separates instance creation from rendering so the same root
* can be reused for multiple sequential screens.
*/
export type Root = {
render: (node: ReactNode) => void
unmount: () => void
waitUntilExit: () => Promise<void>
}
/**
* Mount a component and render the output.
*/
export const renderSync = (
node: ReactNode,
options?: NodeJS.WriteStream | RenderOptions,
): Instance => {
const opts = getOptions(options)
const inkOptions: InkOptions = {
stdout: process.stdout,
stdin: process.stdin,
stderr: process.stderr,
exitOnCtrlC: true,
patchConsole: true,
...opts,
}
const instance: Ink = getInstance(
inkOptions.stdout,
() => new Ink(inkOptions),
)
instance.render(node)
return {
rerender: instance.render,
unmount() {
instance.unmount()
},
waitUntilExit: instance.waitUntilExit,
cleanup: () => instances.delete(inkOptions.stdout),
}
}
const wrappedRender = async (
node: ReactNode,
options?: NodeJS.WriteStream | RenderOptions,
): Promise<Instance> => {
// Preserve the microtask boundary that `await loadYoga()` used to provide.
// Without it, the first render fires synchronously before async startup work
// (e.g. useReplBridge notification state) settles, and the subsequent Static
// write overwrites scrollback instead of appending below the logo.
await Promise.resolve()
const instance = renderSync(node, options)
logForDebugging(
`[render] first ink render: ${Math.round(process.uptime() * 1000)}ms since process start`,
)
return instance
}
export default wrappedRender
/**
* Create an Ink root without rendering anything yet.
* Like react-dom's createRoot — call root.render() to mount a tree.
*/
export async function createRoot({
stdout = process.stdout,
stdin = process.stdin,
stderr = process.stderr,
exitOnCtrlC = true,
patchConsole = true,
onFrame,
}: RenderOptions = {}): Promise<Root> {
// See wrappedRender — preserve microtask boundary from the old WASM await.
await Promise.resolve()
const instance = new Ink({
stdout,
stdin,
stderr,
exitOnCtrlC,
patchConsole,
onFrame,
})
// Register in the instances map so that code that looks up the Ink
// instance by stdout (e.g. external editor pause/resume) can find it.
instances.set(stdout, instance)
return {
render: node => instance.render(node),
unmount: () => instance.unmount(),
waitUntilExit: () => instance.waitUntilExit(),
}
}
const getOptions = (
stdout: NodeJS.WriteStream | RenderOptions | undefined = {},
): RenderOptions => {
if (stdout instanceof Stream) {
return {
stdout,
stdin: process.stdin,
}
}
return stdout
}
const getInstance = (
stdout: NodeJS.WriteStream,
createInstance: () => Ink,
): Ink => {
let instance = instances.get(stdout)
if (!instance) {
instance = createInstance()
instances.set(stdout, instance)
}
return instance
}