@docusaurus/core 0.0.0-4919 → 0.0.0-4924

package/bin/docusaurus.mjs

@@ -54,14 +54,8 @@ cli
     '--no-minify',
     'build website without minimizing JS bundles (default: false)',
   )
-  .action(async (siteDir, {bundleAnalyzer, config, outDir, locale, minify}) => {
-    build(await resolveDir(siteDir), {
-      bundleAnalyzer,
-      outDir,
-      config,
-      locale,
-      minify,
-    });
+  .action(async (siteDir, options) => {
+    build(await resolveDir(siteDir), options);
   });
 
 cli
@@ -86,9 +80,9 @@ cli
     'copy TypeScript theme files when possible (default: false)',
   )
   .option('--danger', 'enable swizzle for unsafe component of themes')
-  .action(async (themeName, componentName, siteDir, options) => {
-    swizzle(await resolveDir(siteDir), themeName, componentName, options);
-  });
+  .action(async (themeName, componentName, siteDir, options) =>
+    swizzle(await resolveDir(siteDir), themeName, componentName, options),
+  );
 
 cli
   .command('deploy [siteDir]')
@@ -109,13 +103,9 @@ cli
     '--skip-build',
     'skip building website before deploy it (default: false)',
   )
-  .action(async (siteDir, {outDir, skipBuild, config}) => {
-    deploy(await resolveDir(siteDir), {
-      outDir,
-      config,
-      skipBuild,
-    });
-  });
+  .action(async (siteDir, options) =>
+    deploy(await resolveDir(siteDir), options),
+  );
 
 cli
   .command('start [siteDir]')
@@ -136,18 +126,8 @@ cli
     '--poll [interval]',
     'use polling rather than watching for reload (default: false). Can specify a poll interval in milliseconds',
   )
-  .action(
-    async (siteDir, {port, host, locale, config, hotOnly, open, poll}) => {
-      start(await resolveDir(siteDir), {
-        port,
-        host,
-        locale,
-        config,
-        hotOnly,
-        open,
-        poll,
-      });
-    },
+  .action(async (siteDir, options) =>
+    start(await resolveDir(siteDir), options),
   );
 
 cli
@@ -164,44 +144,25 @@ 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)')
-  .action(
-    async (
-      siteDir,
-      {
-        dir = 'build',
-        port = 3000,
-        host = 'localhost',
-        build: buildSite = false,
-        config,
-      },
-    ) => {
-      serve(await resolveDir(siteDir), {
-        dir,
-        port,
-        build: buildSite,
-        config,
-        host,
-      });
-    },
+  .action(async (siteDir, options) =>
+    serve(await resolveDir(siteDir), options),
   );
 
 cli
   .command('clear [siteDir]')
   .description('Remove build artifacts.')
-  .action(async (siteDir) => {
-    clear(await resolveDir(siteDir));
-  });
+  .action(async (siteDir) => clear(await resolveDir(siteDir)));
 
 cli
   .command('write-translations [siteDir]')
   .description('Extract required translations of your site.')
   .option(
     '-l, --locale <locale>',
-    'the locale folder to write the translations\n"--locale fr" will write translations in ./i18n/fr folder)',
+    'the locale folder to write the translations.\n"--locale fr" will write translations in the ./i18n/fr folder.',
   )
   .option(
     '--override',
-    'by default, we only append missing translation messages to existing translation files. This option allows to override existing translation messages. Make sure to commit or backup your existing translations, as they may be overridden',
+    'By default, we only append missing translation messages to existing translation files. This option allows to override existing translation messages. Make sure to commit or backup your existing translations, as they may be overridden. (default: false)',
   )
   .option(
     '--config <config>',
@@ -209,20 +170,10 @@ cli
   )
   .option(
     '--messagePrefix <messagePrefix>',
-    'allows to init new written messages with a given prefix. This might help you to highlight untranslated message to make them stand out in the UI',
+    'Allows to init new written messages with a given prefix. This might help you to highlight untranslated message by making them stand out in the UI (default: "")',
   )
-  .action(
-    async (
-      siteDir,
-      {locale = undefined, override = false, messagePrefix = '', config},
-    ) => {
-      writeTranslations(await resolveDir(siteDir), {
-        locale,
-        override,
-        config,
-        messagePrefix,
-      });
-    },
+  .action(async (siteDir, options) =>
+    writeTranslations(await resolveDir(siteDir), options),
   );
 
 cli

package/lib/client/App.d.ts

@@ -5,5 +5,5 @@
  * LICENSE file in the root directory of this source tree.
  */
 /// <reference types="react" />
-import './clientLifecyclesDispatcher';
+import '@generated/client-modules';
 export default function App(): JSX.Element;

package/lib/client/App.js

@@ -5,6 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React from 'react';
+import '@generated/client-modules';
 import routes from '@generated/routes';
 import { useLocation } from '@docusaurus/router';
 import normalizeLocation from './normalizeLocation';
@@ -16,7 +17,6 @@ import BaseUrlIssueBanner from './BaseUrlIssueBanner';
 import SiteMetadataDefaults from './SiteMetadataDefaults';
 import Root from '@theme/Root';
 import SiteMetadata from '@theme/SiteMetadata';
-import './clientLifecyclesDispatcher';
 // TODO, quick fix for CSS insertion order
 import ErrorBoundary from '@docusaurus/ErrorBoundary';
 import Error from '@theme/Error';
@@ -30,7 +30,7 @@ export default function App() {
             <SiteMetadataDefaults />
             <SiteMetadata />
             <BaseUrlIssueBanner />
-            <PendingNavigation location={normalizeLocation(location)} delay={200}>
+            <PendingNavigation location={normalizeLocation(location)}>
               {routeElement}
             </PendingNavigation>
           </Root>

package/lib/client/ClientLifecyclesDispatcher.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { type ReactElement } from 'react';
+import type { ClientModule } from '@docusaurus/types';
+import type { Location } from 'history';
+export declare function dispatchLifecycleAction<K extends keyof ClientModule>(lifecycleAction: K, ...args: Parameters<NonNullable<ClientModule[K]>>): () => void;
+declare function ClientLifecyclesDispatcher({ children, location, previousLocation, }: {
+    children: ReactElement;
+    location: Location;
+    previousLocation: Location | null;
+}): JSX.Element;
+export default ClientLifecyclesDispatcher;

package/lib/client/ClientLifecyclesDispatcher.js

@@ -0,0 +1,34 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { useLayoutEffect } from 'react';
+import clientModules from '@generated/client-modules';
+export function dispatchLifecycleAction(lifecycleAction, ...args) {
+    const callbacks = clientModules.map((clientModule) => {
+        const lifecycleFunction = (clientModule?.default?.[lifecycleAction] ??
+            clientModule[lifecycleAction]);
+        return lifecycleFunction?.(...args);
+    });
+    return () => callbacks.forEach((cb) => cb?.());
+}
+function ClientLifecyclesDispatcher({ children, location, previousLocation, }) {
+    useLayoutEffect(() => {
+        if (previousLocation !== location) {
+            const { hash } = location;
+            if (!hash) {
+                window.scrollTo(0, 0);
+            }
+            else {
+                const id = decodeURIComponent(hash.substring(1));
+                const element = document.getElementById(id);
+                element?.scrollIntoView();
+            }
+            dispatchLifecycleAction('onRouteDidUpdate', { previousLocation, location });
+        }
+    }, [previousLocation, location]);
+    return children;
+}
+export default ClientLifecyclesDispatcher;

package/lib/client/PendingNavigation.d.ts

@@ -6,9 +6,7 @@
  */
 import React from 'react';
 import type { Location } from 'history';
-import './nprogress.css';
 declare type Props = {
-    readonly delay: number;
     readonly location: Location;
     readonly children: JSX.Element;
 };
@@ -17,12 +15,9 @@ declare type State = {
 };
 declare class PendingNavigation extends React.Component<Props, State> {
     private previousLocation;
-    private progressBarTimeout;
+    private routeUpdateCleanupCb;
     constructor(props: Props);
     shouldComponentUpdate(nextProps: Props, nextState: State): boolean;
-    private clearProgressBarTimeout;
-    private startProgressBar;
-    private stopProgressBar;
     render(): JSX.Element;
 }
 export default PendingNavigation;

package/lib/client/PendingNavigation.js

@@ -6,17 +6,20 @@
  */
 import React from 'react';
 import { Route } from 'react-router-dom';
-import nprogress from 'nprogress';
-import clientLifecyclesDispatcher from './clientLifecyclesDispatcher';
+import ClientLifecyclesDispatcher, { dispatchLifecycleAction, } from './ClientLifecyclesDispatcher';
+import ExecutionEnvironment from './exports/ExecutionEnvironment';
 import preload from './preload';
-import './nprogress.css';
-nprogress.configure({ showSpinner: false });
 class PendingNavigation extends React.Component {
     constructor(props) {
         super(props);
         // previousLocation doesn't affect rendering, hence not stored in state.
         this.previousLocation = null;
-        this.progressBarTimeout = null;
+        this.routeUpdateCleanupCb = ExecutionEnvironment.canUseDOM
+            ? dispatchLifecycleAction('onRouteUpdate', {
+                previousLocation: null,
+                location: this.props.location,
+            })
+            : () => { };
         this.state = {
             nextRouteHasLoaded: true,
         };
@@ -35,52 +38,26 @@ class PendingNavigation extends React.Component {
         // Save the location first.
         this.previousLocation = this.props.location;
         this.setState({ nextRouteHasLoaded: false });
-        this.startProgressBar();
+        this.routeUpdateCleanupCb = dispatchLifecycleAction('onRouteUpdate', {
+            previousLocation: this.previousLocation,
+            location: nextLocation,
+        });
         // Load data while the old screen remains.
         preload(nextLocation.pathname)
             .then(() => {
-            clientLifecyclesDispatcher.onRouteUpdate({
-                previousLocation: this.previousLocation,
-                location: nextLocation,
-            });
-            this.setState({ nextRouteHasLoaded: true }, this.stopProgressBar);
-            const { hash } = nextLocation;
-            if (!hash) {
-                window.scrollTo(0, 0);
-            }
-            else {
-                const id = decodeURIComponent(hash.substring(1));
-                const element = document.getElementById(id);
-                element?.scrollIntoView();
-            }
+            this.routeUpdateCleanupCb?.();
+            this.setState({ nextRouteHasLoaded: true });
         })
             .catch((e) => console.warn(e));
         return false;
     }
-    clearProgressBarTimeout() {
-        if (this.progressBarTimeout) {
-            window.clearTimeout(this.progressBarTimeout);
-            this.progressBarTimeout = null;
-        }
-    }
-    startProgressBar() {
-        this.clearProgressBarTimeout();
-        this.progressBarTimeout = window.setTimeout(() => {
-            clientLifecyclesDispatcher.onRouteUpdateDelayed({
-                location: this.props.location,
-            });
-            nprogress.start();
-        }, this.props.delay);
-    }
-    stopProgressBar() {
-        this.clearProgressBarTimeout();
-        nprogress.done();
-    }
     render() {
         const { children, location } = this.props;
         // Use a controlled <Route> to trick all descendants into rendering the old
         // location.
-        return <Route location={location} render={() => children}/>;
+        return (<ClientLifecyclesDispatcher previousLocation={this.previousLocation} location={location}>
+        <Route location={location} render={() => children}/>
+      </ClientLifecyclesDispatcher>);
     }
 }
 export default PendingNavigation;

package/lib/commands/build.d.ts

@@ -5,4 +5,4 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { BuildCLIOptions } from '@docusaurus/types';
-export declare function build(siteDir: string, cliOptions?: Partial<BuildCLIOptions>, forceTerminate?: boolean): Promise<string>;
+export declare function build(siteDir: string, cliOptions: Partial<BuildCLIOptions>, forceTerminate?: boolean): Promise<string>;

package/lib/commands/build.js

@@ -23,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.

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 declare function clear(siteDir: string): Promise<unknown>;
+export declare function clear(siteDir: string): Promise<void>;

package/lib/commands/clear.js

@@ -39,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.clear = clear;

package/lib/commands/deploy.d.ts

@@ -5,4 +5,4 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { BuildCLIOptions } from '@docusaurus/types';
-export declare function deploy(siteDir: string, cliOptions?: Partial<BuildCLIOptions>): Promise<void>;
+export declare function deploy(siteDir: string, cliOptions: Partial<BuildCLIOptions>): Promise<void>;

package/lib/commands/deploy.js

@@ -34,7 +34,7 @@ function shellExecLog(cmd) {
         throw err;
     }
 }
-async function deploy(siteDir, cliOptions = {}) {
+async function deploy(siteDir, cliOptions) {
     const { outDir, siteConfig, siteConfigPath } = await (0, server_1.loadContext)({
         siteDir,
         customConfigFilePath: cliOptions.config,

package/lib/commands/serve.d.ts

@@ -5,4 +5,4 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { ServeCLIOptions } from '@docusaurus/types';
-export declare function serve(siteDir: string, cliOptions: ServeCLIOptions): Promise<void>;
+export declare function serve(siteDir: string, cliOptions: Partial<ServeCLIOptions>): Promise<void>;

package/lib/commands/serve.js

@@ -15,8 +15,10 @@ const path_1 = tslib_1.__importDefault(require("path"));
 const config_1 = require("../server/config");
 const build_1 = require("./build");
 const commandUtils_1 = require("./commandUtils");
+const utils_1 = require("@docusaurus/utils");
 async function serve(siteDir, cliOptions) {
-    let dir = path_1.default.resolve(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.build)(siteDir, {
             config: cliOptions.config,
@@ -52,7 +54,7 @@ async function serve(siteDir, cliOptions) {
             directoryListing: false,
         });
     });
-    logger_1.default.success `Serving path=${cliOptions.dir} directory at url=${servingUrl + baseUrl}.`;
+    logger_1.default.success `Serving path=${buildDir} directory at url=${servingUrl + baseUrl}.`;
     server.listen(port);
 }
 exports.serve = serve;

package/lib/commands/writeHeadingIds.d.ts

@@ -5,4 +5,4 @@
  * LICENSE file in the root directory of this source tree.
  */
 import { type WriteHeadingIDOptions } from '@docusaurus/utils';
-export declare function writeHeadingIds(siteDir: string, files?: string[], options?: WriteHeadingIDOptions): Promise<void>;
+export declare function writeHeadingIds(siteDir: string, files: string[], options: WriteHeadingIDOptions): Promise<void>;

package/lib/commands/writeTranslations.d.ts

@@ -6,6 +6,6 @@
  */
 import type { ConfigOptions } from '@docusaurus/types';
 import { type WriteTranslationsOptions } from '../server/translations/translations';
-export declare function writeTranslations(siteDir: string, options: WriteTranslationsOptions & ConfigOptions & {
+export declare function writeTranslations(siteDir: string, options: Partial<WriteTranslationsOptions & ConfigOptions & {
     locale?: string;
-}): Promise<void>;
+}>): Promise<void>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "0.0.0-4919",
+  "version": "0.0.0-4924",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -41,13 +41,13 @@
     "@babel/runtime": "^7.17.9",
     "@babel/runtime-corejs3": "^7.17.9",
     "@babel/traverse": "^7.17.9",
-    "@docusaurus/cssnano-preset": "0.0.0-4919",
-    "@docusaurus/logger": "0.0.0-4919",
-    "@docusaurus/mdx-loader": "0.0.0-4919",
+    "@docusaurus/cssnano-preset": "0.0.0-4924",
+    "@docusaurus/logger": "0.0.0-4924",
+    "@docusaurus/mdx-loader": "0.0.0-4924",
     "@docusaurus/react-loadable": "5.5.2",
-    "@docusaurus/utils": "0.0.0-4919",
-    "@docusaurus/utils-common": "0.0.0-4919",
-    "@docusaurus/utils-validation": "0.0.0-4919",
+    "@docusaurus/utils": "0.0.0-4924",
+    "@docusaurus/utils-common": "0.0.0-4924",
+    "@docusaurus/utils-validation": "0.0.0-4924",
     "@slorber/static-site-generator-webpack-plugin": "^4.0.4",
     "@svgr/webpack": "^6.2.1",
     "autoprefixer": "^10.4.4",
@@ -77,7 +77,6 @@
     "leven": "^3.1.0",
     "lodash": "^4.17.21",
     "mini-css-extract-plugin": "^2.6.0",
-    "nprogress": "^0.2.0",
     "postcss": "^8.4.12",
     "postcss-loader": "^6.2.1",
     "prompts": "^2.4.2",
@@ -105,10 +104,9 @@
     "webpackbar": "^5.0.2"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4919",
-    "@docusaurus/types": "0.0.0-4919",
+    "@docusaurus/module-type-aliases": "0.0.0-4924",
+    "@docusaurus/types": "0.0.0-4924",
     "@types/detect-port": "^1.3.2",
-    "@types/nprogress": "^0.2.0",
     "@types/react-dom": "^18.0.2",
     "@types/react-router-config": "^5.0.6",
     "@types/rtl-detect": "^1.0.0",
@@ -127,5 +125,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "5bb55e444066669a2af471cc558cd6c61cee8005"
+  "gitHead": "9a5e4f9e3588967ccfb235a808f4bfc1447e403c"
 }

package/lib/client/clientLifecyclesDispatcher.d.ts

@@ -1,9 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-import type { ClientModule } from '@docusaurus/types';
-declare const clientLifecyclesDispatchers: Required<ClientModule>;
-export default clientLifecyclesDispatchers;

package/lib/client/clientLifecyclesDispatcher.js

@@ -1,23 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-import clientModules from '@generated/client-modules';
-function dispatchLifecycleAction(lifecycleAction, args) {
-    clientModules.forEach((clientModule) => {
-        const lifecycleFunction = (clientModule?.default?.[lifecycleAction] ??
-            clientModule[lifecycleAction]);
-        lifecycleFunction?.(...args);
-    });
-}
-const clientLifecyclesDispatchers = {
-    onRouteUpdate(...args) {
-        dispatchLifecycleAction('onRouteUpdate', args);
-    },
-    onRouteUpdateDelayed(...args) {
-        dispatchLifecycleAction('onRouteUpdateDelayed', args);
-    },
-};
-export default clientLifecyclesDispatchers;

package/lib/client/nprogress.css

@@ -1,36 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-/**
- * Styles for NProgress
- * Copied over to remove unused styles for the spinner.
- * https://github.com/rstacruz/nprogress/blob/master/nprogress.css
- */
-
-#nprogress {
-  pointer-events: none;
-}
-
-#nprogress .bar {
-  background: #29d;
-  position: fixed;
-  z-index: 1031;
-  top: 0;
-  left: 0;
-  width: 100%;
-  height: 2px;
-}
-
-#nprogress .peg {
-  position: absolute;
-  right: 0;
-  width: 100px;
-  height: 100%;
-  box-shadow: 0 0 10px #29d, 0 0 5px #29d;
-  opacity: 1;
-  transform: rotate(3deg) translate(0, -4px);
-}