@docusaurus/core 3.6.1 → 3.6.2

package/bin/docusaurus.mjs

@@ -10,19 +10,8 @@
 
 import {inspect} from 'node:util';
 import {logger} from '@docusaurus/logger';
-import cli from 'commander';
 import {DOCUSAURUS_VERSION} from '@docusaurus/utils';
-import {
-  build,
-  swizzle,
-  deploy,
-  start,
-  externalCommand,
-  serve,
-  clear,
-  writeTranslations,
-  writeHeadingIds,
-} from '../lib/index.js';
+import {runCLI} from '../lib/index.js';
 import beforeCli from './beforeCli.mjs';
 
 // Env variables are initialized to dev, but can be overridden by each command
@@ -31,270 +20,28 @@ import beforeCli from './beforeCli.mjs';
 process.env.BABEL_ENV ??= 'development';
 process.env.NODE_ENV ??= 'development';
 
-await beforeCli();
-
-/**
- * @param {string} locale
- * @param {string[]} locales
- * @returns {string[]}
- */
-function concatLocaleOptions(locale, locales = []) {
-  return locales.concat(locale);
-}
-
-cli.version(DOCUSAURUS_VERSION).usage('<command> [options]');
-
-cli
-  .command('build [siteDir]')
-  .description('Build website.')
-  .option(
-    '--dev',
-    'Builds the website in dev mode, including full React error messages.',
-  )
-  .option(
-    '--bundle-analyzer',
-    'visualize size of webpack output files with an interactive zoomable tree map (default: false)',
-  )
-  .option(
-    '--out-dir <dir>',
-    'the full path for the new output directory, relative to the current workspace (default: build)',
-  )
-  .option(
-    '--config <config>',
-    'path to docusaurus config file (default: `[siteDir]/docusaurus.config.js`)',
-  )
-  .option(
-    '-l, --locale <locale...>',
-    'build the site in the specified locale(s). Build all known locales otherwise',
-    concatLocaleOptions,
-  )
-  .option(
-    '--no-minify',
-    'build website without minimizing JS bundles (default: false)',
-  )
-  .action(build);
-
-cli
-  .command('swizzle [themeName] [componentName] [siteDir]')
-  .description(
-    'Wraps or ejects the original theme files into website folder for customization.',
-  )
-  .option(
-    '-w, --wrap',
-    'Creates a wrapper around the original theme component.\nAllows rendering other components before/after the original theme component.',
-  )
-  .option(
-    '-e, --eject',
-    'Ejects the full source code of the original theme component.\nAllows overriding the original component entirely with your own UI and logic.',
-  )
-  .option(
-    '-l, --list',
-    'only list the available themes/components without further prompting (default: false)',
-  )
-  .option(
-    '-t, --typescript',
-    'copy TypeScript theme files when possible (default: false)',
-  )
-  .option(
-    '-j, --javascript',
-    'copy JavaScript theme files when possible (default: false)',
-  )
-  .option('--danger', 'enable swizzle for unsafe component of themes')
-  .option(
-    '--config <config>',
-    'path to Docusaurus config file (default: `[siteDir]/docusaurus.config.js`)',
-  )
-  .action(swizzle);
-
-cli
-  .command('deploy [siteDir]')
-  .description('Deploy website to GitHub pages.')
-  .option(
-    '-l, --locale <locale>',
-    'deploy the site in the specified locale(s). Deploy all known locales otherwise',
-    concatLocaleOptions,
-  )
-  .option(
-    '--out-dir <dir>',
-    'the full path for the new output directory, relative to the current workspace (default: build)',
-  )
-  .option(
-    '--config <config>',
-    'path to Docusaurus config file (default: `[siteDir]/docusaurus.config.js`)',
-  )
-  .option(
-    '--skip-build',
-    'skip building website before deploy it (default: false)',
-  )
-  .option(
-    '--target-dir <dir>',
-    'path to the target directory to deploy to (default: `.`)',
-  )
-  .action(deploy);
-
 /**
- * @param {string | undefined} value
- * @returns {boolean | number}
+ * @param {unknown} error
  */
-function normalizePollValue(value) {
-  if (value === undefined || value === '') {
-    return false;
-  }
-
-  const parsedIntValue = Number.parseInt(value, 10);
-  if (!Number.isNaN(parsedIntValue)) {
-    return parsedIntValue;
-  }
-
-  return value === 'true';
-}
-
-cli
-  .command('start [siteDir]')
-  .description('Start the development server.')
-  .option('-p, --port <port>', 'use specified port (default: 3000)')
-  .option('-h, --host <host>', 'use specified host (default: localhost)')
-  .option('-l, --locale <locale>', 'use specified site locale')
-  .option(
-    '--hot-only',
-    'do not fallback to page refresh if hot reload fails (default: false)',
-  )
-  .option(
-    '--config <config>',
-    'path to Docusaurus config file (default: `[siteDir]/docusaurus.config.js`)',
-  )
-  .option('--no-open', 'do not open page in the browser (default: false)')
-  .option(
-    '--poll [interval]',
-    'use polling rather than watching for reload (default: false). Can specify a poll interval in milliseconds',
-    normalizePollValue,
-  )
-  .option(
-    '--no-minify',
-    'build website without minimizing JS bundles (default: false)',
-  )
-  .action(start);
-
-cli
-  .command('serve [siteDir]')
-  .description('Serve website locally.')
-  .option(
-    '--dir <dir>',
-    'the full path for the new output directory, relative to the current workspace (default: build)',
-  )
-  .option(
-    '--config <config>',
-    'path to Docusaurus config file (default: `[siteDir]/docusaurus.config.js`)',
-  )
-  .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, or true in CI)',
-  )
-  .action(serve);
-
-cli
-  .command('clear [siteDir]')
-  .description('Remove build artifacts.')
-  .action(clear);
-
-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 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. (default: false)',
-  )
-  .option(
-    '--config <config>',
-    'path to Docusaurus config file (default:`[siteDir]/docusaurus.config.js`)',
-  )
-  .option(
-    '--messagePrefix <messagePrefix>',
-    '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(writeTranslations);
-
-cli
-  .command('write-heading-ids [siteDir] [files...]')
-  .description('Generate heading ids in Markdown content.')
-  .option(
-    '--maintain-case',
-    "keep the headings' casing, otherwise make all lowercase (default: false)",
-  )
-  .option('--overwrite', 'overwrite existing heading IDs (default: false)')
-  .action(writeHeadingIds);
-
-cli.arguments('<command>').action((cmd) => {
-  cli.outputHelp();
-  logger.error`Unknown Docusaurus CLI command name=${cmd}.`;
-  process.exit(1);
-});
-
-// === The above is the commander configuration ===
-// They don't start any code execution yet until cli.parse() is called below
-
-/**
- * @param {string | undefined} command
- */
-function isInternalCommand(command) {
-  return (
-    command &&
-    [
-      'start',
-      'build',
-      'swizzle',
-      'deploy',
-      'serve',
-      'clear',
-      'write-translations',
-      'write-heading-ids',
-    ].includes(command)
-  );
-}
-
-/**
- * @param {string | undefined} command
- */
-function isExternalCommand(command) {
-  return !!(command && !isInternalCommand(command) && !command.startsWith('-'));
-}
-
-// No command? We print the help message because Commander doesn't
-// Note argv looks like this: ['../node','../docusaurus.mjs','<command>',...rest]
-if (process.argv.length < 3) {
-  cli.outputHelp();
-  logger.error`Please provide a Docusaurus CLI command.`;
-  process.exit(1);
-}
-
-// There is an unrecognized subcommand
-// Let plugins extend the CLI before parsing
-if (isExternalCommand(process.argv[2])) {
-  // TODO: in this step, we must assume default site structure because there's
-  // no way to know the siteDir/config yet. Maybe the root cli should be
-  // responsible for parsing these arguments?
-  // https://github.com/facebook/docusaurus/issues/8903
-  await externalCommand(cli);
-}
-
-cli.parse(process.argv);
-
-process.on('unhandledRejection', (err) => {
+function handleError(error) {
   console.log('');
 
   // We need to use inspect with increased depth to log the full causal chain
   // By default Node logging has depth=2
   // see also https://github.com/nodejs/node/issues/51637
-  logger.error(inspect(err, {depth: Infinity}));
+  logger.error(inspect(error, {depth: Infinity}));
 
   logger.info`Docusaurus version: number=${DOCUSAURUS_VERSION}
 Node version: number=${process.version}`;
   process.exit(1);
-});
+}
+
+process.on('unhandledRejection', handleError);
+
+try {
+  await beforeCli();
+  // @ts-expect-error: we know it has at least 2 args
+  await runCLI(process.argv);
+} catch (e) {
+  handleError(e);
+}

package/lib/commands/cli.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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 CommanderStatic } from 'commander';
+type CLIProgram = CommanderStatic;
+type CLIArgs = [string, string, ...string[]];
+export declare function runCLI(cliArgs: CLIArgs): Promise<void>;
+export declare function createCLIProgram({ cli, cliArgs, siteDir, config, }: {
+    cli: CLIProgram;
+    cliArgs: CLIArgs;
+    siteDir: string;
+    config: string | undefined;
+}): Promise<CLIProgram>;
+export {};

package/lib/commands/cli.js

@@ -0,0 +1,154 @@
+"use strict";
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runCLI = runCLI;
+exports.createCLIProgram = createCLIProgram;
+const tslib_1 = require("tslib");
+const logger_1 = require("@docusaurus/logger");
+const commander_1 = tslib_1.__importDefault(require("commander"));
+const utils_1 = require("@docusaurus/utils");
+const build_1 = require("./build/build");
+const clear_1 = require("./clear");
+const deploy_1 = require("./deploy");
+const external_1 = require("./external");
+const serve_1 = require("./serve");
+const start_1 = require("./start/start");
+const swizzle_1 = require("./swizzle");
+const writeHeadingIds_1 = require("./writeHeadingIds");
+const writeTranslations_1 = require("./writeTranslations");
+function concatLocaleOptions(locale, locales = []) {
+    return locales.concat(locale);
+}
+function isInternalCommand(command) {
+    return (command &&
+        [
+            'start',
+            'build',
+            'swizzle',
+            'deploy',
+            'serve',
+            'clear',
+            'write-translations',
+            'write-heading-ids',
+        ].includes(command));
+}
+// TODO: Annoying, we must assume default site dir is '.' because there's
+//  no way to know the siteDir/config yet.
+//  The individual CLI commands can declare/read siteDir on their own
+//  The env variable is an escape hatch
+//  See https://github.com/facebook/docusaurus/issues/8903
+const DEFAULT_SITE_DIR = process.env.DOCUSAURUS_CLI_SITE_DIR ?? '.';
+// Similarly we give an env escape hatch for config
+// See https://github.com/facebook/docusaurus/issues/8903
+const DEFAULT_CONFIG = process.env.DOCUSAURUS_CLI_CONFIG ?? undefined;
+async function runCLI(cliArgs) {
+    const program = await createCLIProgram({
+        cli: commander_1.default,
+        cliArgs,
+        siteDir: DEFAULT_SITE_DIR,
+        config: DEFAULT_CONFIG,
+    });
+    await program.parseAsync(cliArgs);
+}
+async function createCLIProgram({ cli, cliArgs, siteDir, config, }) {
+    const command = cliArgs[2];
+    cli.version(utils_1.DOCUSAURUS_VERSION).usage('<command> [options]');
+    cli
+        .command('build [siteDir]')
+        .description('Build website.')
+        .option('--dev', 'Builds the website in dev mode, including full React error messages.')
+        .option('--bundle-analyzer', 'visualize size of webpack output files with an interactive zoomable tree map (default: false)')
+        .option('--out-dir <dir>', 'the full path for the new output directory, relative to the current workspace (default: build)')
+        .option('--config <config>', 'path to docusaurus config file (default: `[siteDir]/docusaurus.config.js`)')
+        .option('-l, --locale <locale...>', 'build the site in the specified locale(s). Build all known locales otherwise', concatLocaleOptions)
+        .option('--no-minify', 'build website without minimizing JS bundles (default: false)')
+        .action(build_1.build);
+    cli
+        .command('swizzle [themeName] [componentName] [siteDir]')
+        .description('Wraps or ejects the original theme files into website folder for customization.')
+        .option('-w, --wrap', 'Creates a wrapper around the original theme component.\nAllows rendering other components before/after the original theme component.')
+        .option('-e, --eject', 'Ejects the full source code of the original theme component.\nAllows overriding the original component entirely with your own UI and logic.')
+        .option('-l, --list', 'only list the available themes/components without further prompting (default: false)')
+        .option('-t, --typescript', 'copy TypeScript theme files when possible (default: false)')
+        .option('-j, --javascript', 'copy JavaScript theme files when possible (default: false)')
+        .option('--danger', 'enable swizzle for unsafe component of themes')
+        .option('--config <config>', 'path to Docusaurus config file (default: `[siteDir]/docusaurus.config.js`)')
+        .action(swizzle_1.swizzle);
+    cli
+        .command('deploy [siteDir]')
+        .description('Deploy website to GitHub pages.')
+        .option('-l, --locale <locale>', 'deploy the site in the specified locale(s). Deploy all known locales otherwise', concatLocaleOptions)
+        .option('--out-dir <dir>', 'the full path for the new output directory, relative to the current workspace (default: build)')
+        .option('--config <config>', 'path to Docusaurus config file (default: `[siteDir]/docusaurus.config.js`)')
+        .option('--skip-build', 'skip building website before deploy it (default: false)')
+        .option('--target-dir <dir>', 'path to the target directory to deploy to (default: `.`)')
+        .action(deploy_1.deploy);
+    function normalizePollValue(value) {
+        if (value === undefined || value === '') {
+            return false;
+        }
+        const parsedIntValue = Number.parseInt(value, 10);
+        if (!Number.isNaN(parsedIntValue)) {
+            return parsedIntValue;
+        }
+        return value === 'true';
+    }
+    cli
+        .command('start [siteDir]')
+        .description('Start the development server.')
+        .option('-p, --port <port>', 'use specified port (default: 3000)')
+        .option('-h, --host <host>', 'use specified host (default: localhost)')
+        .option('-l, --locale <locale>', 'use specified site locale')
+        .option('--hot-only', 'do not fallback to page refresh if hot reload fails (default: false)')
+        .option('--config <config>', 'path to Docusaurus config file (default: `[siteDir]/docusaurus.config.js`)')
+        .option('--no-open', 'do not open page in the browser (default: false)')
+        .option('--poll [interval]', 'use polling rather than watching for reload (default: false). Can specify a poll interval in milliseconds', normalizePollValue)
+        .option('--no-minify', 'build website without minimizing JS bundles (default: false)')
+        .action(start_1.start);
+    cli
+        .command('serve [siteDir]')
+        .description('Serve website locally.')
+        .option('--dir <dir>', 'the full path for the new output directory, relative to the current workspace (default: build)')
+        .option('--config <config>', 'path to Docusaurus config file (default: `[siteDir]/docusaurus.config.js`)')
+        .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, or true in CI)')
+        .action(serve_1.serve);
+    cli
+        .command('clear [siteDir]')
+        .description('Remove build artifacts.')
+        .action(clear_1.clear);
+    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 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. (default: false)')
+        .option('--config <config>', 'path to Docusaurus config file (default:`[siteDir]/docusaurus.config.js`)')
+        .option('--messagePrefix <messagePrefix>', '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(writeTranslations_1.writeTranslations);
+    cli
+        .command('write-heading-ids [siteDir] [files...]')
+        .description('Generate heading ids in Markdown content.')
+        .option('--maintain-case', "keep the headings' casing, otherwise make all lowercase (default: false)")
+        .option('--overwrite', 'overwrite existing heading IDs (default: false)')
+        .action(writeHeadingIds_1.writeHeadingIds);
+    cli.arguments('<command>').action((cmd) => {
+        cli.outputHelp();
+        if (!cmd) {
+            throw new Error(logger_1.logger.interpolate `Missing Docusaurus CLI command.`);
+        }
+        throw new Error(logger_1.logger.interpolate `Unknown Docusaurus CLI command code=${cmd}`);
+    });
+    // There is an unrecognized subcommand
+    // Let plugins extend the CLI before parsing
+    if (!isInternalCommand(command)) {
+        await (0, external_1.externalCommand)({ cli, siteDir, config });
+    }
+    return cli;
+}

package/lib/commands/external.d.ts

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

package/lib/commands/external.js

@@ -11,9 +11,9 @@ const tslib_1 = require("tslib");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const site_1 = require("../server/site");
 const init_1 = require("../server/plugins/init");
-async function externalCommand(cli) {
-    const siteDir = await fs_extra_1.default.realpath('.');
-    const context = await (0, site_1.loadContext)({ siteDir });
+async function externalCommand({ cli, siteDir: siteDirInput, config, }) {
+    const siteDir = await fs_extra_1.default.realpath(siteDirInput);
+    const context = await (0, site_1.loadContext)({ siteDir, config });
     const plugins = await (0, init_1.initPlugins)(context);
     // Plugin Lifecycle - extendCli.
     plugins.forEach((plugin) => {

package/lib/index.d.ts

@@ -4,6 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+export { runCLI } from './commands/cli';
 export { build } from './commands/build/build';
 export { clear } from './commands/clear';
 export { deploy } from './commands/deploy';

package/lib/index.js

@@ -6,7 +6,9 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.writeTranslations = exports.writeHeadingIds = exports.swizzle = exports.start = exports.serve = exports.externalCommand = exports.deploy = exports.clear = exports.build = void 0;
+exports.writeTranslations = exports.writeHeadingIds = exports.swizzle = exports.start = exports.serve = exports.externalCommand = exports.deploy = exports.clear = exports.build = exports.runCLI = void 0;
+var cli_1 = require("./commands/cli");
+Object.defineProperty(exports, "runCLI", { enumerable: true, get: function () { return cli_1.runCLI; } });
 var build_1 = require("./commands/build/build");
 Object.defineProperty(exports, "build", { enumerable: true, get: function () { return build_1.build; } });
 var clear_1 = require("./commands/clear");

package/lib/server/config.js

@@ -18,10 +18,11 @@ async function findConfig(siteDir) {
     const candidates = ['.ts', '.mts', '.cts', '.js', '.mjs', '.cjs'].map((ext) => utils_1.DEFAULT_CONFIG_FILE_NAME + ext);
     const configPath = await (0, utils_1.findAsyncSequential)(candidates.map((file) => path_1.default.join(siteDir, file)), fs_extra_1.default.pathExists);
     if (!configPath) {
-        logger_1.default.error('No config file found.');
-        logger_1.default.info `Expected one of:${candidates}
-You can provide a custom config path with the code=${'--config'} option.`;
-        throw new Error();
+        const relativeSiteDir = path_1.default.relative(process.cwd(), siteDir);
+        throw new Error(logger_1.default.interpolate `No config file found in site dir code=${relativeSiteDir}.
+Expected one of:${candidates.map(logger_1.default.code)}
+You can provide a custom config path with the code=${'--config'} option.
+    `);
     }
     return configPath;
 }

package/lib/webpack/base.js

@@ -89,10 +89,24 @@ async function createBaseConfig({ props, isServer, minify, faster, configureWebp
             },
         };
     }
+    function getExperiments() {
+        if (props.currentBundler.name === 'rspack') {
+            return {
+                // This is mostly useful in dev
+                // See https://rspack.dev/config/experiments#experimentsincremental
+                // Produces warnings in production builds
+                // See https://github.com/web-infra-dev/rspack/pull/8311#issuecomment-2476014664
+                // @ts-expect-error: Rspack-only
+                incremental: !isProd,
+            };
+        }
+        return undefined;
+    }
     return {
         mode,
         name,
         cache: getCache(),
+        experiments: getExperiments(),
         output: {
             pathinfo: false,
             path: outDir,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "3.6.1",
+  "version": "3.6.2",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -33,13 +33,13 @@
     "url": "https://github.com/facebook/docusaurus/issues"
   },
   "dependencies": {
-    "@docusaurus/babel": "3.6.1",
-    "@docusaurus/bundler": "3.6.1",
-    "@docusaurus/logger": "3.6.1",
-    "@docusaurus/mdx-loader": "3.6.1",
-    "@docusaurus/utils": "3.6.1",
-    "@docusaurus/utils-common": "3.6.1",
-    "@docusaurus/utils-validation": "3.6.1",
+    "@docusaurus/babel": "3.6.2",
+    "@docusaurus/bundler": "3.6.2",
+    "@docusaurus/logger": "3.6.2",
+    "@docusaurus/mdx-loader": "3.6.2",
+    "@docusaurus/utils": "3.6.2",
+    "@docusaurus/utils-common": "3.6.2",
+    "@docusaurus/utils-validation": "3.6.2",
     "boxen": "^6.2.1",
     "chalk": "^4.1.2",
     "chokidar": "^3.5.3",
@@ -78,8 +78,8 @@
     "webpack-merge": "^6.0.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.6.1",
-    "@docusaurus/types": "3.6.1",
+    "@docusaurus/module-type-aliases": "3.6.2",
+    "@docusaurus/types": "3.6.2",
     "@total-typescript/shoehorn": "^0.1.2",
     "@types/detect-port": "^1.3.3",
     "@types/react-dom": "^18.2.7",
@@ -100,5 +100,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "c971734bb55f4e7c2d1c679b41dcbeb6f2a6c8ad"
+  "gitHead": "77f402d1f167dbb7468465078b1ed7750e65cc5d"
 }