@docusaurus/core 2.0.0-beta.18 → 2.0.0-beta.19

package/lib/client/prefetch.js

@@ -4,20 +4,14 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-function support(feature) {
-    if (typeof document === 'undefined') {
-        return false;
-    }
-    const fakeLink = document.createElement('link');
+function supports(feature) {
     try {
-        if (fakeLink.relList && typeof fakeLink.relList.supports === 'function') {
-            return fakeLink.relList.supports(feature);
-        }
+        const fakeLink = document.createElement('link');
+        return fakeLink.relList?.supports?.(feature);
     }
     catch (err) {
         return false;
     }
-    return false;
 }
 function linkPrefetchStrategy(url) {
     return new Promise((resolve, reject) => {
@@ -28,8 +22,8 @@ function linkPrefetchStrategy(url) {
         const link = document.createElement('link');
         link.setAttribute('rel', 'prefetch');
         link.setAttribute('href', url);
-        link.onload = resolve;
-        link.onerror = reject;
+        link.onload = () => resolve();
+        link.onerror = () => reject();
         const parentElement = document.getElementsByTagName('head')[0] ??
             document.getElementsByName('script')[0]?.parentNode;
         parentElement?.appendChild(link);
@@ -51,21 +45,9 @@ function xhrPrefetchStrategy(url) {
         req.send(null);
     });
 }
-const supportedPrefetchStrategy = support('prefetch')
+const supportedPrefetchStrategy = supports('prefetch')
     ? linkPrefetchStrategy
     : xhrPrefetchStrategy;
-const preFetched = {};
 export default function prefetch(url) {
-    return new Promise((resolve) => {
-        if (preFetched[url]) {
-            resolve();
-            return;
-        }
-        supportedPrefetchStrategy(url)
-            .then(() => {
-            resolve();
-            preFetched[url] = true;
-        })
-            .catch(() => { }); // 404s are logged to the console anyway.
-    });
+    return supportedPrefetchStrategy(url).catch(() => { }); // 404s are logged to the console anyway.
 }

package/lib/client/preload.d.ts

@@ -4,14 +4,12 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { type RouteConfig } from 'react-router-config';
 /**
  * Helper function to make sure all async components for that particular route
  * is preloaded before rendering. This is especially useful to avoid loading
  * screens.
  *
- * @param routes react-router-config
  * @param pathname the route pathname, example: /docs/installation
  * @returns Promise object represents whether pathname has been preloaded
  */
-export default function preload(routes: RouteConfig[], pathname: string): Promise<void[]>;
+export default function preload(pathname: string): Promise<void[]>;

package/lib/client/preload.js

@@ -4,17 +4,17 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+import routes from '@generated/routes';
 import { matchRoutes } from 'react-router-config';
 /**
  * Helper function to make sure all async components for that particular route
  * is preloaded before rendering. This is especially useful to avoid loading
  * screens.
  *
- * @param routes react-router-config
  * @param pathname the route pathname, example: /docs/installation
  * @returns Promise object represents whether pathname has been preloaded
  */
-export default function preload(routes, pathname) {
+export default function preload(pathname) {
     const matches = matchRoutes(routes, pathname);
     return Promise.all(
     // @ts-expect-error: ComponentCreator injected this method.

package/lib/client/routeContext.js

@@ -19,7 +19,7 @@ function mergeContexts({ parent, value, }) {
     // TODO deep merge this
     const data = { ...parent.data, ...value?.data };
     return {
-        // nested routes are not supposed to override plugin attribute
+        // Nested routes are not supposed to override plugin attribute
         plugin: parent.plugin,
         data,
     };

package/lib/client/serverEntry.js

@@ -14,15 +14,13 @@ import Loadable from 'react-loadable';
 import { minify } from 'html-minifier-terser';
 import path from 'path';
 import fs from 'fs-extra';
-import routes from '@generated/routes';
 import preload from './preload';
 import App from './App';
 import { createStatefulLinksCollector, LinksCollectorProvider, } from './LinksCollector';
 import logger from '@docusaurus/logger';
 // eslint-disable-next-line no-restricted-imports
 import _ from 'lodash';
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const packageJson = require('../../package.json');
+import { DOCUSAURUS_VERSION } from '@docusaurus/utils';
 const getCompiledSSRTemplate = _.memoize((template) => eta.compile(template.trim(), {
     rmWhitespace: true,
 }));
@@ -39,7 +37,7 @@ export default async function render(locals) {
         const isNotDefinedErrorRegex = /(?:window|document|localStorage|navigator|alert|location|buffer|self) is not defined/i;
         if (isNotDefinedErrorRegex.test(err.message)) {
             logger.info `It looks like you are using code that should run on the client-side only.
-To get around it, try using code=${'<BrowserOnly>'} (path=${'https://docusaurus.io/docs/docusaurus-core/#browseronly'}) or code=${'ExecutionEnvironment'} (path=${'https://docusaurus.io/docs/docusaurus-core/#executionenvironment'}).
+To get around it, try using code=${'<BrowserOnly>'} (url=${'https://docusaurus.io/docs/docusaurus-core/#browseronly'}) or code=${'ExecutionEnvironment'} (url=${'https://docusaurus.io/docs/docusaurus-core/#executionenvironment'}).
 It might also require to wrap your client code in code=${'useEffect'} hook and/or import a third-party library dynamically (if any).`;
         }
         throw err;
@@ -47,16 +45,18 @@ It might also require to wrap your client code in code=${'useEffect'} hook and/o
 }
 // Renderer for static-site-generator-webpack-plugin (async rendering).
 async function doRender(locals) {
-    const { routesLocation, headTags, preBodyTags, postBodyTags, onLinksCollected, baseUrl, ssrTemplate, noIndex, } = locals;
+    const { routesLocation, headTags, preBodyTags, postBodyTags, onLinksCollected, onHeadTagsCollected, baseUrl, ssrTemplate, noIndex, } = locals;
     const location = routesLocation[locals.path];
-    await preload(routes, location);
+    await preload(location);
     const modules = new Set();
-    const context = {};
+    const routerContext = {};
     const helmetContext = {};
     const linksCollector = createStatefulLinksCollector();
-    const appHtml = ReactDOMServer.renderToString(<Loadable.Capture report={(moduleName) => modules.add(moduleName)}>
+    const appHtml = ReactDOMServer.renderToString(
+    // @ts-expect-error: we are migrating away from react-loadable anyways
+    <Loadable.Capture report={(moduleName) => modules.add(moduleName)}>
       <HelmetProvider context={helmetContext}>
-        <StaticRouter location={location} context={context}>
+        <StaticRouter location={location} context={routerContext}>
           <LinksCollectorProvider linksCollector={linksCollector}>
             <App />
           </LinksCollectorProvider>
@@ -73,10 +73,11 @@ async function doRender(locals) {
         helmet.link.toString(),
         helmet.script.toString(),
     ];
+    onHeadTagsCollected(location, helmet);
     const metaAttributes = metaStrings.filter(Boolean);
     const { generatedFilesDir } = locals;
     const manifestPath = path.join(generatedFilesDir, 'client-manifest.json');
-    const manifest = JSON.parse(await fs.readFile(manifestPath, 'utf8'));
+    const manifest = await fs.readJSON(manifestPath);
     // Get all required assets for this particular page based on client
     // manifest information.
     const modulesToBeLoaded = [...manifest.entrypoints, ...Array.from(modules)];
@@ -95,7 +96,7 @@ async function doRender(locals) {
         scripts,
         stylesheets,
         noIndex,
-        version: packageJson.version,
+        version: DOCUSAURUS_VERSION,
     });
     try {
         // Minify html with https://github.com/DanielRuf/html-minifier-terser

package/lib/client/theme-fallback/Error/index.js

@@ -4,6 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+// Should we translate theme-fallback?
+/* eslint-disable @docusaurus/no-untranslated-text */
 import React from 'react';
 import Layout from '@theme/Layout';
 import ErrorBoundary from '@docusaurus/ErrorBoundary';

package/lib/client/theme-fallback/Loading/index.js

@@ -4,6 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+// Should we translate theme-fallback?
+/* eslint-disable @docusaurus/no-untranslated-text */
 import React from 'react';
 export default function Loading({ error, retry, pastDelay, }) {
     if (error) {

package/lib/client/theme-fallback/NotFound/index.js

@@ -4,6 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+// Should we translate theme-fallback?
+/* eslint-disable @docusaurus/no-untranslated-text */
 import React from 'react';
 import Layout from '@theme/Layout';
 import Head from '@docusaurus/Head';

package/lib/commands/build.d.ts

@@ -4,5 +4,9 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { BuildCLIOptions } from '@docusaurus/types';
-export default function build(siteDir: string, cliOptions?: Partial<BuildCLIOptions>, forceTerminate?: boolean): Promise<string>;
+import { type LoadContextOptions } from '../server';
+export declare type BuildCLIOptions = Pick<LoadContextOptions, 'config' | 'locale' | 'outDir'> & {
+    bundleAnalyzer?: boolean;
+    minify?: boolean;
+};
+export declare function build(siteDir: string, cliOptions: Partial<BuildCLIOptions>, forceTerminate?: boolean): Promise<string>;

package/lib/commands/build.js

@@ -6,6 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.build = void 0;
 const tslib_1 = require("tslib");
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const copy_webpack_plugin_1 = tslib_1.__importDefault(require("copy-webpack-plugin"));
@@ -22,7 +23,7 @@ const utils_1 = require("../webpack/utils");
 const CleanWebpackPlugin_1 = tslib_1.__importDefault(require("../webpack/plugins/CleanWebpackPlugin"));
 const i18n_1 = require("../server/i18n");
 const utils_2 = require("@docusaurus/utils");
-async function build(siteDir, cliOptions = {}, 
+async function build(siteDir, cliOptions, 
 // When running build, we force terminate the process to prevent async
 // operations from never returning. However, if run as part of docusaurus
 // deploy, we have to let deploy finish.
@@ -46,9 +47,10 @@ forceTerminate = true) {
             throw err;
         }
     }
-    const context = await (0, server_1.loadContext)(siteDir, {
-        customOutDir: cliOptions.outDir,
-        customConfigFilePath: cliOptions.config,
+    const context = await (0, server_1.loadContext)({
+        siteDir,
+        outDir: cliOptions.outDir,
+        config: cliOptions.config,
         locale: cliOptions.locale,
         localizePath: cliOptions.locale ? false : undefined,
     });
@@ -73,19 +75,20 @@ forceTerminate = true) {
     });
     return results[0];
 }
-exports.default = build;
+exports.build = build;
 async function buildLocale({ siteDir, locale, cliOptions, forceTerminate, isLastLocale, }) {
     process.env.BABEL_ENV = 'production';
     process.env.NODE_ENV = 'production';
     logger_1.default.info `name=${`[${locale}]`} Creating an optimized production build...`;
-    const props = await (0, server_1.load)(siteDir, {
-        customOutDir: cliOptions.outDir,
-        customConfigFilePath: cliOptions.config,
+    const props = await (0, server_1.load)({
+        siteDir,
+        outDir: cliOptions.outDir,
+        config: cliOptions.config,
         locale,
         localizePath: cliOptions.locale ? false : undefined,
     });
     // Apply user webpack config.
-    const { outDir, generatedFilesDir, plugins, siteConfig: { baseUrl, onBrokenLinks, staticDirectories }, routes, } = props;
+    const { outDir, generatedFilesDir, plugins, siteConfig: { baseUrl, onBrokenLinks, staticDirectories: staticDirectoriesOption, }, routes, } = props;
     const clientManifestPath = path_1.default.join(generatedFilesDir, 'client-manifest.json');
     let clientConfig = (0, webpack_merge_1.default)(await (0, client_1.default)(props, cliOptions.minify), {
         plugins: [
@@ -98,23 +101,36 @@ async function buildLocale({ siteDir, locale, cliOptions, forceTerminate, isLast
             new react_loadable_ssr_addon_v5_slorber_1.default({
                 filename: clientManifestPath,
             }),
-        ].filter(Boolean),
+        ].filter((x) => Boolean(x)),
     });
     const allCollectedLinks = {};
+    const headTags = {};
     let serverConfig = await (0, server_2.default)({
         props,
         onLinksCollected: (staticPagePath, links) => {
             allCollectedLinks[staticPagePath] = links;
         },
+        onHeadTagsCollected: (staticPagePath, tags) => {
+            headTags[staticPagePath] = tags;
+        },
     });
+    // The staticDirectories option can contain empty directories, or non-existent
+    // directories (e.g. user deleted `static`). Instead of issuing an error, we
+    // just silently filter them out, because user could have never configured it
+    // in the first place (the default option should always "work").
+    const staticDirectories = (await Promise.all(staticDirectoriesOption.map(async (dir) => {
+        const staticDir = path_1.default.resolve(siteDir, dir);
+        if ((await fs_extra_1.default.pathExists(staticDir)) &&
+            (await fs_extra_1.default.readdir(staticDir)).length > 0) {
+            return staticDir;
+        }
+        return '';
+    }))).filter(Boolean);
     if (staticDirectories.length > 0) {
-        await Promise.all(staticDirectories.map((dir) => fs_extra_1.default.ensureDir(dir)));
         serverConfig = (0, webpack_merge_1.default)(serverConfig, {
             plugins: [
                 new copy_webpack_plugin_1.default({
-                    patterns: staticDirectories
-                        .map((dir) => path_1.default.resolve(siteDir, dir))
-                        .map((dir) => ({ from: dir, to: outDir })),
+                    patterns: staticDirectories.map((dir) => ({ from: dir, to: outDir })),
                 }),
             ],
         });
@@ -151,7 +167,11 @@ async function buildLocale({ siteDir, locale, cliOptions, forceTerminate, isLast
         if (!plugin.postBuild) {
             return;
         }
-        await plugin.postBuild({ ...props, content: plugin.content });
+        await plugin.postBuild({
+            ...props,
+            head: headTags,
+            content: plugin.content,
+        });
     }));
     await (0, brokenLinks_1.handleBrokenLinks)({
         allCollectedLinks,

package/lib/commands/clear.d.ts

@@ -4,4 +4,4 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-export default function clear(siteDir: string): Promise<unknown>;
+export declare function clear(siteDir: string): Promise<void>;

package/lib/commands/clear.js

@@ -6,6 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.clear = void 0;
 const tslib_1 = require("tslib");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const path_1 = tslib_1.__importDefault(require("path"));
@@ -38,6 +39,6 @@ async function clear(siteDir) {
         path: path_1.default.join(siteDir, p, '.cache'),
         description: 'Webpack persistent cache folder',
     }));
-    return Promise.all([generatedFolder, buildFolder, ...cacheFolders].map(removePath));
+    await Promise.all([generatedFolder, buildFolder, ...cacheFolders].map(removePath));
 }
-exports.default = clear;
+exports.clear = clear;

package/lib/commands/deploy.d.ts

@@ -4,5 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { BuildCLIOptions } from '@docusaurus/types';
-export default function deploy(siteDir: string, cliOptions?: Partial<BuildCLIOptions>): Promise<void>;
+import { type LoadContextOptions } from '../server';
+export declare type DeployCLIOptions = Pick<LoadContextOptions, 'config' | 'locale' | 'outDir'> & {
+    skipBuild?: boolean;
+};
+export declare function deploy(siteDir: string, cliOptions: Partial<DeployCLIOptions>): Promise<void>;

package/lib/commands/deploy.js

@@ -6,13 +6,14 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.deploy = void 0;
 const tslib_1 = require("tslib");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const shelljs_1 = tslib_1.__importDefault(require("shelljs"));
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const utils_1 = require("@docusaurus/utils");
 const server_1 = require("../server");
-const build_1 = tslib_1.__importDefault(require("./build"));
+const build_1 = require("./build");
 const path_1 = tslib_1.__importDefault(require("path"));
 const os_1 = tslib_1.__importDefault(require("os"));
 // GIT_PASS env variable should not appear in logs
@@ -33,10 +34,11 @@ function shellExecLog(cmd) {
         throw err;
     }
 }
-async function deploy(siteDir, cliOptions = {}) {
-    const { outDir, siteConfig, siteConfigPath } = await (0, server_1.loadContext)(siteDir, {
-        customConfigFilePath: cliOptions.config,
-        customOutDir: cliOptions.outDir,
+async function deploy(siteDir, cliOptions) {
+    const { outDir, siteConfig, siteConfigPath } = await (0, server_1.loadContext)({
+        siteDir,
+        config: cliOptions.config,
+        outDir: cliOptions.outDir,
     });
     if (typeof siteConfig.trailingSlash === 'undefined') {
         logger_1.default.warn(`When deploying to GitHub Pages, it is better to use an explicit "trailingSlash" site config.
@@ -87,8 +89,9 @@ This behavior can have SEO impacts and create relative link issues.
         shelljs_1.default.echo('Skipping deploy on a pull request.');
         shelljs_1.default.exit(0);
     }
-    // github.io indicates organization repos that deploy via default branch.
-    // All others use gh-pages. Organization deploys looks like:
+    // github.io indicates organization repos that deploy via default branch. All
+    // others use gh-pages (either case can be configured actually, but we can
+    // make educated guesses). Organization deploys look like:
     // - Git repo: https://github.com/<organization>/<organization>.github.io
     // - Site url: https://<organization>.github.io
     const isGitHubPagesOrganizationDeploy = projectName.includes('.github.io');
@@ -172,7 +175,7 @@ You can also set the deploymentBranch property in docusaurus.config.js .`);
     if (!cliOptions.skipBuild) {
         // Build site, then push to deploymentBranch branch of specified repo.
         try {
-            await runDeploy(await (0, build_1.default)(siteDir, cliOptions, false));
+            await (0, build_1.build)(siteDir, cliOptions, false).then(runDeploy);
         }
         catch (err) {
             logger_1.default.error('Deployment of the build output failed.');
@@ -184,4 +187,4 @@ You can also set the deploymentBranch property in docusaurus.config.js .`);
         await runDeploy(outDir);
     }
 }
-exports.default = deploy;
+exports.deploy = deploy;

package/lib/commands/external.d.ts

@@ -5,4 +5,4 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { CommanderStatic } from 'commander';
-export default function externalCommand(cli: CommanderStatic, siteDir: string): Promise<void>;
+export declare function externalCommand(cli: CommanderStatic, siteDir: string): Promise<void>;

package/lib/commands/external.js

@@ -6,16 +6,15 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
+exports.externalCommand = void 0;
 const server_1 = require("../server");
-const init_1 = tslib_1.__importDefault(require("../server/plugins/init"));
+const init_1 = require("../server/plugins/init");
 async function externalCommand(cli, siteDir) {
-    const context = await (0, server_1.loadContext)(siteDir);
-    const pluginConfigs = await (0, server_1.loadPluginConfigs)(context);
-    const plugins = await (0, init_1.default)({ pluginConfigs, context });
+    const context = await (0, server_1.loadContext)({ siteDir });
+    const plugins = await (0, init_1.initPlugins)(context);
     // Plugin Lifecycle - extendCli.
     plugins.forEach((plugin) => {
         plugin.extendCli?.(cli);
     });
 }
-exports.default = externalCommand;
+exports.externalCommand = externalCommand;

package/lib/commands/serve.d.ts

@@ -4,5 +4,10 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { ServeCLIOptions } from '@docusaurus/types';
-export default function serve(siteDir: string, cliOptions: ServeCLIOptions): Promise<void>;
+import type { LoadContextOptions } from '../server';
+import { type HostPortOptions } from '../server/getHostPort';
+export declare type ServeCLIOptions = HostPortOptions & Pick<LoadContextOptions, 'config'> & {
+    dir?: string;
+    build?: boolean;
+};
+export declare function serve(siteDir: string, cliOptions: Partial<ServeCLIOptions>): Promise<void>;

package/lib/commands/serve.js

@@ -6,30 +6,30 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.serve = void 0;
 const tslib_1 = require("tslib");
 const http_1 = tslib_1.__importDefault(require("http"));
 const serve_handler_1 = tslib_1.__importDefault(require("serve-handler"));
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const path_1 = tslib_1.__importDefault(require("path"));
-const server_1 = require("../server");
-const build_1 = tslib_1.__importDefault(require("./build"));
-const commandUtils_1 = require("./commandUtils");
+const config_1 = require("../server/config");
+const build_1 = require("./build");
+const getHostPort_1 = require("../server/getHostPort");
+const utils_1 = require("@docusaurus/utils");
 async function serve(siteDir, cliOptions) {
-    let dir = path_1.default.isAbsolute(cliOptions.dir)
-        ? cliOptions.dir
-        : path_1.default.join(siteDir, cliOptions.dir);
+    const buildDir = cliOptions.dir ?? utils_1.DEFAULT_BUILD_DIR_NAME;
+    let dir = path_1.default.resolve(siteDir, buildDir);
     if (cliOptions.build) {
-        dir = await (0, build_1.default)(siteDir, {
+        dir = await (0, build_1.build)(siteDir, {
             config: cliOptions.config,
             outDir: dir,
         }, false);
     }
-    const host = (0, commandUtils_1.getCLIOptionHost)(cliOptions.host);
-    const port = await (0, commandUtils_1.getCLIOptionPort)(cliOptions.port, host);
+    const { host, port } = await (0, getHostPort_1.getHostPort)(cliOptions);
     if (port === null) {
         process.exit();
     }
-    const { siteConfig: { baseUrl, trailingSlash }, } = await (0, server_1.loadSiteConfig)({
+    const { siteConfig: { baseUrl, trailingSlash }, } = await (0, config_1.loadSiteConfig)({
         siteDir,
         customConfigFilePath: cliOptions.config,
     });
@@ -53,7 +53,7 @@ async function serve(siteDir, cliOptions) {
             directoryListing: false,
         });
     });
-    logger_1.default.success `Serving path=${cliOptions.dir} directory at path=${servingUrl + baseUrl}.`;
+    logger_1.default.success `Serving path=${buildDir} directory at url=${servingUrl + baseUrl}.`;
     server.listen(port);
 }
-exports.default = serve;
+exports.serve = serve;

package/lib/commands/start.d.ts

@@ -4,5 +4,11 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { StartCLIOptions } from '@docusaurus/types';
-export default function start(siteDir: string, cliOptions: Partial<StartCLIOptions>): Promise<void>;
+import { type LoadContextOptions } from '../server';
+import { type HostPortOptions } from '../server/getHostPort';
+export declare type StartCLIOptions = HostPortOptions & Pick<LoadContextOptions, 'locale' | 'config'> & {
+    hotOnly?: boolean;
+    open?: boolean;
+    poll?: boolean | number;
+};
+export declare function start(siteDir: string, cliOptions: Partial<StartCLIOptions>): Promise<void>;

package/lib/commands/start.js

@@ -6,6 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.start = void 0;
 const tslib_1 = require("tslib");
 const utils_1 = require("@docusaurus/utils");
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
@@ -22,38 +23,38 @@ const webpack_merge_1 = tslib_1.__importDefault(require("webpack-merge"));
 const server_1 = require("../server");
 const client_1 = tslib_1.__importDefault(require("../webpack/client"));
 const utils_2 = require("../webpack/utils");
-const commandUtils_1 = require("./commandUtils");
+const getHostPort_1 = require("../server/getHostPort");
 const translations_1 = require("../server/translations/translations");
 async function start(siteDir, cliOptions) {
     process.env.NODE_ENV = 'development';
     process.env.BABEL_ENV = 'development';
     logger_1.default.info('Starting the development server...');
     function loadSite() {
-        return (0, server_1.load)(siteDir, {
-            customConfigFilePath: cliOptions.config,
+        return (0, server_1.load)({
+            siteDir,
+            config: cliOptions.config,
             locale: cliOptions.locale,
-            localizePath: undefined, // should this be configurable?
+            localizePath: undefined, // Should this be configurable?
         });
     }
     // Process all related files as a prop.
     const props = await loadSite();
     const protocol = process.env.HTTPS === 'true' ? 'https' : 'http';
-    const host = (0, commandUtils_1.getCLIOptionHost)(cliOptions.host);
-    const port = await (0, commandUtils_1.getCLIOptionPort)(cliOptions.port, host);
+    const { host, port } = await (0, getHostPort_1.getHostPort)(cliOptions);
     if (port === null) {
         process.exit();
     }
     const { baseUrl, headTags, preBodyTags, postBodyTags } = props;
     const urls = (0, WebpackDevServerUtils_1.prepareUrls)(protocol, host, port);
     const openUrl = (0, utils_1.normalizeUrl)([urls.localUrlForBrowser, baseUrl]);
-    logger_1.default.success `Docusaurus website is running at path=${openUrl}.`;
+    logger_1.default.success `Docusaurus website is running at url=${openUrl}.`;
     // Reload files processing.
     const reload = lodash_1.default.debounce(() => {
         loadSite()
             .then(({ baseUrl: newBaseUrl }) => {
             const newOpenUrl = (0, utils_1.normalizeUrl)([urls.localUrlForBrowser, newBaseUrl]);
             if (newOpenUrl !== openUrl) {
-                logger_1.default.success `Docusaurus website is running at path=${newOpenUrl}.`;
+                logger_1.default.success `Docusaurus website is running at url=${newOpenUrl}.`;
             }
         })
             .catch((err) => {
@@ -93,6 +94,10 @@ async function start(siteDir, cliOptions) {
     });
     ['add', 'change', 'unlink', 'addDir', 'unlinkDir'].forEach((event) => fsWatcher.on(event, reload));
     let config = (0, webpack_merge_1.default)(await (0, client_1.default)(props), {
+        watchOptions: {
+            ignored: /node_modules\/(?!@docusaurus)/,
+            poll: cliOptions.poll,
+        },
         infrastructureLogging: {
             // Reduce log verbosity, see https://github.com/facebook/docusaurus/pull/5420#issuecomment-906613105
             level: 'warn',
@@ -198,4 +203,4 @@ async function start(siteDir, cliOptions) {
         });
     });
 }
-exports.default = start;
+exports.start = start;

package/lib/commands/swizzle/actions.d.ts

@@ -5,9 +5,9 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { SwizzleAction, SwizzleComponentConfig } from '@docusaurus/types';
-import type { SwizzleOptions } from './common';
+import type { SwizzleCLIOptions } from './common';
 export declare const SwizzleActions: SwizzleAction[];
-export declare function getAction(componentConfig: SwizzleComponentConfig, options: Pick<SwizzleOptions, 'wrap' | 'eject'>): Promise<SwizzleAction>;
+export declare function getAction(componentConfig: SwizzleComponentConfig, options: Pick<SwizzleCLIOptions, 'wrap' | 'eject'>): Promise<SwizzleAction>;
 export declare type ActionParams = {
     siteDir: string;
     themePath: string;