forked from vitejs/vite
-
Notifications
You must be signed in to change notification settings - Fork 0
/
shortcuts.ts
159 lines (140 loc) · 3.84 KB
/
shortcuts.ts
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
import readline from 'node:readline'
import colors from 'picocolors'
import { restartServerWithUrls } from './server'
import type { ViteDevServer } from './server'
import type { PreviewServer } from './preview'
import { openBrowser } from './server/openBrowser'
export type BindCLIShortcutsOptions<Server = ViteDevServer | PreviewServer> = {
/**
* Print a one-line shortcuts "help" hint to the terminal
*/
print?: boolean
/**
* Custom shortcuts to run when a key is pressed. These shortcuts take priority
* over the default shortcuts if they have the same keys (except the `h` key).
*/
customShortcuts?: CLIShortcut<Server>[]
}
export type CLIShortcut<Server = ViteDevServer | PreviewServer> = {
key: string
description: string
action(server: Server): void | Promise<void>
}
export function bindCLIShortcuts<Server extends ViteDevServer | PreviewServer>(
server: Server,
opts?: BindCLIShortcutsOptions<Server>,
): void {
if (!server.httpServer || !process.stdin.isTTY || process.env.CI) {
return
}
const isDev = isDevServer(server)
if (isDev) {
server._shortcutsOptions = opts as BindCLIShortcutsOptions<ViteDevServer>
}
if (opts?.print) {
server.config.logger.info(
colors.dim(colors.green(' ➜')) +
colors.dim(' press ') +
colors.bold('h + enter') +
colors.dim(' to show help'),
)
}
const shortcuts = (opts?.customShortcuts ?? [])
// @ts-expect-error passing the right types, but typescript can't detect it
.concat(isDev ? BASE_DEV_SHORTCUTS : BASE_PREVIEW_SHORTCUTS)
let actionRunning = false
const onInput = async (input: string) => {
if (actionRunning) return
if (input === 'h') {
const loggedKeys = new Set<string>()
server.config.logger.info('\n Shortcuts')
for (const shortcut of shortcuts) {
if (loggedKeys.has(shortcut.key)) continue
loggedKeys.add(shortcut.key)
server.config.logger.info(
colors.dim(' press ') +
colors.bold(`${shortcut.key} + enter`) +
colors.dim(` to ${shortcut.description}`),
)
}
return
}
const shortcut = shortcuts.find((shortcut) => shortcut.key === input)
if (!shortcut) return
actionRunning = true
await shortcut.action(server)
actionRunning = false
}
const rl = readline.createInterface({ input: process.stdin })
rl.on('line', onInput)
server.httpServer.on('close', () => rl.close())
}
function isDevServer(
server: ViteDevServer | PreviewServer,
): server is ViteDevServer {
return 'pluginContainer' in server
}
const BASE_DEV_SHORTCUTS: CLIShortcut<ViteDevServer>[] = [
{
key: 'r',
description: 'restart the server',
async action(server) {
await restartServerWithUrls(server)
},
},
{
key: 'u',
description: 'show server url',
action(server) {
server.config.logger.info('')
server.printUrls()
},
},
{
key: 'o',
description: 'open in browser',
action(server) {
server.openBrowser()
},
},
{
key: 'c',
description: 'clear console',
action(server) {
server.config.logger.clearScreen('error')
},
},
{
key: 'q',
description: 'quit',
async action(server) {
await server.close().finally(() => process.exit())
},
},
]
const BASE_PREVIEW_SHORTCUTS: CLIShortcut<PreviewServer>[] = [
{
key: 'o',
description: 'open in browser',
action(server) {
const url =
server.resolvedUrls?.local[0] ?? server.resolvedUrls?.network[0]
if (url) {
openBrowser(url, true, server.config.logger)
} else {
server.config.logger.warn('No URL available to open in browser')
}
},
},
{
key: 'q',
description: 'quit',
action(server) {
try {
server.httpServer.close()
} finally {
process.exit()
}
},
},
]