feat: export server.bindCLIShortcuts (#13675)

vitejs · Sep 4, 2023 · 1a2e5e6 · 1a2e5e6
1 parent 34c7cb4
commit 1a2e5e6
Show file tree

Hide file tree

Showing 6 changed files with 39 additions and 15 deletions.
diff --git a/docs/guide/api-javascript.md b/docs/guide/api-javascript.md
@@ -30,6 +30,7 @@ const __dirname = fileURLToPath(new URL('.', import.meta.url))
   await server.listen()
 
   server.printUrls()
+  server.bindCLIShortcuts({ print: true })
 })()
 ```
 
@@ -138,6 +139,10 @@ interface ViteDevServer {
    * Stop the server.
    */
   close(): Promise<void>
+  /**
+   * Bind CLI shortcuts
+   */
+  bindCLIShortcuts(options?: BindCLIShortcutsOptions<ViteDevServer>): void
 }
 ```
 
@@ -195,6 +200,7 @@ import { preview } from 'vite'
   })
 
   previewServer.printUrls()
+  previewServer.bindCLIShortcuts({ print: true })
 })()
 ```
 
@@ -228,6 +234,10 @@ interface PreviewServer {
    * Print server urls
    */
   printUrls(): void
+  /**
+   * Bind CLI shortcuts
+   */
+  bindCLIShortcuts(options?: BindCLIShortcutsOptions<PreviewServer>): void
 }
 ```
 

diff --git a/packages/vite/src/node/cli.ts b/packages/vite/src/node/cli.ts
@@ -8,7 +8,6 @@ import type { ServerOptions } from './server'
 import type { LogLevel } from './logger'
 import { createLogger } from './logger'
 import { VERSION } from './constants'
-import { bindShortcuts } from './shortcuts'
 import { resolveConfig } from '.'
 
 const cli = cac('vite')
@@ -178,7 +177,7 @@ cli
       )
 
       server.printUrls()
-      bindShortcuts(server, {
+      server.bindCLIShortcuts({
         print: true,
         customShortcuts: [
           profileSession && {
@@ -355,7 +354,7 @@ cli
           },
         })
         server.printUrls()
-        bindShortcuts(server, { print: true })
+        server.bindCLIShortcuts({ print: true })
       } catch (e) {
         createLogger(options.logLevel).error(
           colors.red(`error when starting preview server:\n${e.stack}`),

diff --git a/packages/vite/src/node/index.ts b/packages/vite/src/node/index.ts
@@ -99,6 +99,8 @@ export type {
 } from './server/transformRequest'
 export type { HmrOptions, HmrContext } from './server/hmr'
 
+export type { BindCLIShortcutsOptions, CLIShortcut } from './shortcuts'
+
 export type {
   HMRPayload,
   ConnectedPayload,

diff --git a/packages/vite/src/node/preview.ts b/packages/vite/src/node/preview.ts
@@ -18,6 +18,8 @@ import compression from './server/middlewares/compression'
 import { proxyMiddleware } from './server/middlewares/proxy'
 import { resolveHostname, resolveServerUrls, shouldServeFile } from './utils'
 import { printServerUrls } from './logger'
+import { bindCLIShortcuts } from './shortcuts'
+import type { BindCLIShortcutsOptions } from './shortcuts'
 import { DEFAULT_PREVIEW_PORT } from './constants'
 import { resolveConfig } from '.'
 import type { InlineConfig, ResolvedConfig } from '.'
@@ -72,6 +74,10 @@ export interface PreviewServer {
    * Print server urls
    */
   printUrls(): void
+  /**
+   * Bind CLI shortcuts
+   */
+  bindCLIShortcuts(options?: BindCLIShortcutsOptions<PreviewServer>): void
 }
 
 export type PreviewServerHook = (
@@ -130,6 +136,9 @@ export async function preview(
         throw new Error('cannot print server URLs before server is listening.')
       }
     },
+    bindCLIShortcuts(options) {
+      bindCLIShortcuts(server as PreviewServer, options)
+    },
   }
 
   // apply server hooks from plugins

diff --git a/packages/vite/src/node/server/index.ts b/packages/vite/src/node/server/index.ts
@@ -40,8 +40,8 @@ import {
   initDepsOptimizer,
   initDevSsrDepsOptimizer,
 } from '../optimizer'
-import { bindShortcuts } from '../shortcuts'
-import type { BindShortcutsOptions } from '../shortcuts'
+import { bindCLIShortcuts } from '../shortcuts'
+import type { BindCLIShortcutsOptions } from '../shortcuts'
 import { CLIENT_DIR, DEFAULT_DEV_PORT } from '../constants'
 import type { Logger } from '../logger'
 import { printServerUrls } from '../logger'
@@ -271,6 +271,10 @@ export interface ViteDevServer {
    * Print server urls
    */
   printUrls(): void
+  /**
+   * Bind CLI shortcuts
+   */
+  bindCLIShortcuts(options?: BindCLIShortcutsOptions<ViteDevServer>): void
   /**
    * Restart the server.
    *
@@ -316,11 +320,8 @@ export interface ViteDevServer {
   _fsDenyGlob: Matcher
   /**
    * @internal
-   * Actually BindShortcutsOptions | undefined but api-extractor checks for
-   * export before trimming internal types :(
-   * And I don't want to add complexity to prePatchTypes for that
    */
-  _shortcutsOptions: any | undefined
+  _shortcutsOptions?: BindCLIShortcutsOptions<ViteDevServer>
 }
 
 export interface ResolvedServerUrls {
@@ -493,6 +494,9 @@ export async function _createServer(
         )
       }
     },
+    bindCLIShortcuts(options) {
+      bindCLIShortcuts(server, options)
+    },
     async restart(forceOptimize?: boolean) {
       if (!server._restartPromise) {
         server._forceOptimizeOnRestart = !!forceOptimize
@@ -828,7 +832,7 @@ export function resolveServerOptions(
 async function restartServer(server: ViteDevServer) {
   global.__vite_start_time = performance.now()
   const { port: prevPort, host: prevHost } = server.config.server
-  const shortcutsOptions: BindShortcutsOptions = server._shortcutsOptions
+  const shortcutsOptions = server._shortcutsOptions
   const oldUrls = server.resolvedUrls
 
   let inlineConfig = server.config.inlineConfig
@@ -879,7 +883,7 @@ async function restartServer(server: ViteDevServer) {
 
   if (shortcutsOptions) {
     shortcutsOptions.print = false
-    bindShortcuts(newServer, shortcutsOptions)
+    bindCLIShortcuts(newServer, shortcutsOptions)
   }
 }
 

diff --git a/packages/vite/src/node/shortcuts.ts b/packages/vite/src/node/shortcuts.ts
@@ -4,7 +4,7 @@ import { isDefined } from './utils'
 import type { PreviewServer } from './preview'
 import { openBrowser } from './server/openBrowser'
 
-export type BindShortcutsOptions<Server = ViteDevServer | PreviewServer> = {
+export type BindCLIShortcutsOptions<Server = ViteDevServer | PreviewServer> = {
   /**
    * Print a one line hint to the terminal.
    */
@@ -18,9 +18,9 @@ export type CLIShortcut<Server = ViteDevServer | PreviewServer> = {
   action(server: Server): void | Promise<void>
 }
 
-export function bindShortcuts<Server extends ViteDevServer | PreviewServer>(
+export function bindCLIShortcuts<Server extends ViteDevServer | PreviewServer>(
   server: Server,
-  opts?: BindShortcutsOptions<Server>,
+  opts?: BindCLIShortcutsOptions<Server>,
 ): void {
   if (!server.httpServer || !process.stdin.isTTY || process.env.CI) {
     return
@@ -29,7 +29,7 @@ export function bindShortcuts<Server extends ViteDevServer | PreviewServer>(
   const isDev = isDevServer(server)
 
   if (isDev) {
-    server._shortcutsOptions = opts
+    server._shortcutsOptions = opts as BindCLIShortcutsOptions<ViteDevServer>
   }
 
   if (opts?.print) {