feat: add automatic url open to npm run serve

facebook · May 26, 2022 · dcb15a7 · dcb15a7
1 parent 89ddc6d
commit dcb15a7
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/packages/docusaurus/bin/docusaurus.mjs b/packages/docusaurus/bin/docusaurus.mjs
@@ -148,6 +148,7 @@ cli
   .option('-p, --port <port>', 'use specified port (default: 3000)')
   .option('--build', 'build website before serving (default: false)')
   .option('-h, --host <host>', 'use specified host (default: localhost)')
+  .option('--no-open', 'do not open page in the browser (default: false)')
   .action(async (siteDir, options) =>
     serve(await resolveDir(siteDir), options),
   );

diff --git a/packages/docusaurus/src/commands/serve.ts b/packages/docusaurus/src/commands/serve.ts
@@ -10,6 +10,7 @@ import path from 'path';
 import logger from '@docusaurus/logger';
 import {DEFAULT_BUILD_DIR_NAME} from '@docusaurus/utils';
 import serveHandler from 'serve-handler';
+import openBrowser from 'react-dev-utils/openBrowser';
 import {loadSiteConfig} from '../server/config';
 import {build} from './build';
 import {getHostPort, type HostPortOptions} from '../server/getHostPort';
@@ -19,6 +20,7 @@ export type ServeCLIOptions = HostPortOptions &
   Pick<LoadContextOptions, 'config'> & {
     dir?: string;
     build?: boolean;
+    open?: boolean;
   };
 
 export async function serve(
@@ -76,8 +78,11 @@ export async function serve(
     });
   });
 
-  logger.success`Serving path=${buildDir} directory at url=${
-    servingUrl + baseUrl
-  }.`;
+  const url = servingUrl + baseUrl;
+  logger.success`Serving path=${buildDir} directory at url=${url}.`;
   server.listen(port);
+
+  if (cliOptions.open) {
+    openBrowser(url);
+  }
 }