@docusaurus/core 0.0.0-5121 → 0.0.0-5124

package/bin/docusaurus.mjs

@@ -8,7 +8,6 @@
 
 // @ts-check
 
-import fs from 'fs-extra';
 import logger from '@docusaurus/logger';
 import cli from 'commander';
 import {DOCUSAURUS_VERSION} from '@docusaurus/utils';
@@ -27,8 +26,6 @@ import beforeCli from './beforeCli.mjs';
 
 await beforeCli();
 
-const resolveDir = (dir = '.') => fs.realpath(dir);
-
 cli.version(DOCUSAURUS_VERSION).usage('<command> [options]');
 
 cli
@@ -54,9 +51,9 @@ cli
     '--no-minify',
     'build website without minimizing JS bundles (default: false)',
   )
-  .action(async (siteDir, options) => {
-    await build(await resolveDir(siteDir), options);
-  });
+  // @ts-expect-error: Promise<string> is not assignable to Promise<void>... but
+  // good enough here.
+  .action(build);
 
 cli
   .command('swizzle [themeName] [componentName] [siteDir]')
@@ -80,9 +77,7 @@ 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(swizzle);
 
 cli
   .command('deploy [siteDir]')
@@ -103,9 +98,7 @@ cli
     '--skip-build',
     'skip building website before deploy it (default: false)',
   )
-  .action(async (siteDir, options) =>
-    deploy(await resolveDir(siteDir), options),
-  );
+  .action(deploy);
 
 cli
   .command('start [siteDir]')
@@ -130,9 +123,7 @@ cli
     '--no-minify',
     'build website without minimizing JS bundles (default: false)',
   )
-  .action(async (siteDir, options) =>
-    start(await resolveDir(siteDir), options),
-  );
+  .action(start);
 
 cli
   .command('serve [siteDir]')
@@ -152,14 +143,12 @@ cli
     '--no-open',
     'do not open page in the browser (default: false, or true in CI)',
   )
-  .action(async (siteDir, options) =>
-    serve(await resolveDir(siteDir), options),
-  );
+  .action(serve);
 
 cli
   .command('clear [siteDir]')
   .description('Remove build artifacts.')
-  .action(async (siteDir) => clear(await resolveDir(siteDir)));
+  .action(clear);
 
 cli
   .command('write-translations [siteDir]')
@@ -180,9 +169,7 @@ cli
     '--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(async (siteDir, options) =>
-    writeTranslations(await resolveDir(siteDir), options),
-  );
+  .action(writeTranslations);
 
 cli
   .command('write-heading-ids [siteDir] [files...]')
@@ -192,9 +179,7 @@ cli
     "keep the headings' casing, otherwise make all lowercase (default: false)",
   )
   .option('--overwrite', 'overwrite existing heading IDs (default: false)')
-  .action(async (siteDir, files, options) =>
-    writeHeadingIds(await resolveDir(siteDir), files, options),
-  );
+  .action(writeHeadingIds);
 
 cli.arguments('<command>').action((cmd) => {
   cli.outputHelp();
@@ -221,7 +206,7 @@ function isInternalCommand(command) {
 }
 
 if (!isInternalCommand(process.argv.slice(2)[0])) {
-  await externalCommand(cli, await resolveDir('.'));
+  await externalCommand(cli);
 }
 
 if (!process.argv.slice(2).length) {

package/lib/client/serverEntry.js

@@ -108,6 +108,9 @@ async function doRender(locals) {
         version: DOCUSAURUS_VERSION,
     });
     try {
+        if (process.env.SKIP_HTML_MINIFICATION === 'true') {
+            return renderedHtml;
+        }
         // Minify html with https://github.com/DanielRuf/html-minifier-terser
         return await minify(renderedHtml, {
             removeComments: false,

package/lib/commands/build.d.ts

@@ -9,4 +9,4 @@ export declare type BuildCLIOptions = Pick<LoadContextOptions, 'config' | 'local
     bundleAnalyzer?: boolean;
     minify?: boolean;
 };
-export declare function build(siteDir: string, cliOptions: Partial<BuildCLIOptions>, forceTerminate?: boolean): Promise<string>;
+export declare function build(siteDirParam?: string, cliOptions?: Partial<BuildCLIOptions>, forceTerminate?: boolean): Promise<string>;

package/lib/commands/build.js

@@ -23,12 +23,13 @@ const server_2 = tslib_1.__importDefault(require("../webpack/server"));
 const utils_2 = require("../webpack/utils");
 const CleanWebpackPlugin_1 = tslib_1.__importDefault(require("../webpack/plugins/CleanWebpackPlugin"));
 const i18n_1 = require("../server/i18n");
-async function build(siteDir, cliOptions, 
+async function build(siteDirParam = '.', 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.
 // See https://github.com/facebook/docusaurus/pull/2496
 forceTerminate = true) {
+    const siteDir = await fs_extra_1.default.realpath(siteDirParam);
     ['SIGINT', 'SIGTERM'].forEach((sig) => {
         process.on(sig, () => process.exit());
     });

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

package/lib/commands/clear.js

@@ -25,7 +25,8 @@ async function removePath(entry) {
         logger_1.default.error(err);
     }
 }
-async function clear(siteDir) {
+async function clear(siteDirParam = '.') {
+    const siteDir = await fs_extra_1.default.realpath(siteDirParam);
     const generatedFolder = {
         path: path_1.default.join(siteDir, utils_1.GENERATED_FILES_DIR_NAME),
         description: 'generated folder',

package/lib/commands/deploy.d.ts

@@ -8,4 +8,4 @@ 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>;
+export declare function deploy(siteDirParam?: string, cliOptions?: Partial<DeployCLIOptions>): Promise<void>;

package/lib/commands/deploy.js

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

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 declare function externalCommand(cli: CommanderStatic, siteDir: string): Promise<void>;
+export declare function externalCommand(cli: CommanderStatic): Promise<void>;

package/lib/commands/external.js

@@ -7,9 +7,12 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.externalCommand = void 0;
+const tslib_1 = require("tslib");
+const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const server_1 = require("../server");
 const init_1 = require("../server/plugins/init");
-async function externalCommand(cli, siteDir) {
+async function externalCommand(cli) {
+    const siteDir = await fs_extra_1.default.realpath('.');
     const context = await (0, server_1.loadContext)({ siteDir });
     const plugins = await (0, init_1.initPlugins)(context);
     // Plugin Lifecycle - extendCli.

package/lib/commands/serve.d.ts

@@ -11,4 +11,4 @@ export declare type ServeCLIOptions = HostPortOptions & Pick<LoadContextOptions,
     build?: boolean;
     open?: boolean;
 };
-export declare function serve(siteDir: string, cliOptions: Partial<ServeCLIOptions>): Promise<void>;
+export declare function serve(siteDirParam?: string, cliOptions?: Partial<ServeCLIOptions>): Promise<void>;

package/lib/commands/serve.js

@@ -8,6 +8,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.serve = void 0;
 const tslib_1 = require("tslib");
+const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const http_1 = tslib_1.__importDefault(require("http"));
 const path_1 = tslib_1.__importDefault(require("path"));
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
@@ -17,7 +18,8 @@ const openBrowser_1 = tslib_1.__importDefault(require("react-dev-utils/openBrows
 const config_1 = require("../server/config");
 const build_1 = require("./build");
 const getHostPort_1 = require("../server/getHostPort");
-async function serve(siteDir, cliOptions) {
+async function serve(siteDirParam = '.', cliOptions = {}) {
+    const siteDir = await fs_extra_1.default.realpath(siteDirParam);
     const buildDir = cliOptions.dir ?? utils_1.DEFAULT_BUILD_DIR_NAME;
     let dir = path_1.default.resolve(siteDir, buildDir);
     if (cliOptions.build) {

package/lib/commands/start.d.ts

@@ -12,4 +12,4 @@ export declare type StartCLIOptions = HostPortOptions & Pick<LoadContextOptions,
     poll?: boolean | number;
     minify?: boolean;
 };
-export declare function start(siteDir: string, cliOptions: Partial<StartCLIOptions>): Promise<void>;
+export declare function start(siteDirParam?: string, cliOptions?: Partial<StartCLIOptions>): Promise<void>;

package/lib/commands/start.js

@@ -8,6 +8,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.start = 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"));
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
@@ -24,7 +25,8 @@ const server_1 = require("../server");
 const client_1 = tslib_1.__importDefault(require("../webpack/client"));
 const utils_2 = require("../webpack/utils");
 const getHostPort_1 = require("../server/getHostPort");
-async function start(siteDir, cliOptions) {
+async function start(siteDirParam = '.', cliOptions = {}) {
+    const siteDir = await fs_extra_1.default.realpath(siteDirParam);
     process.env.NODE_ENV = 'development';
     process.env.BABEL_ENV = 'development';
     logger_1.default.info('Starting the development server...');

package/lib/commands/swizzle/actions.js

@@ -69,11 +69,12 @@ async function wrap({ siteDir, themePath, componentName: themeComponentName, typ
     await fs_extra_1.default.ensureDir(path_1.default.resolve(siteDir, utils_1.THEME_PATH));
     const toPath = path_1.default.resolve(siteDir, utils_1.THEME_PATH, wrapperFileName);
     const content = typescript
-        ? `import React, {ComponentProps} from 'react';
+        ? `import React from 'react';
 import ${componentName} from '@theme-${importType}/${themeComponentName}';
 import type ${componentName}Type from '@theme/${themeComponentName}';
+import type {WrapperProps} from '@docusaurus/types';
 
-type Props = ComponentProps<typeof ${componentName}Type>;
+type Props = WrapperProps<typeof ${componentName}Type>;
 
 export default function ${wrapperComponentName}(props: Props): JSX.Element {
   return (

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

@@ -5,4 +5,4 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { SwizzleCLIOptions } from './common';
-export declare function swizzle(siteDir: string, themeNameParam: string | undefined, componentNameParam: string | undefined, optionsParam: Partial<SwizzleCLIOptions>): Promise<void>;
+export declare function swizzle(themeNameParam?: string | undefined, componentNameParam?: string | undefined, siteDirParam?: string, optionsParam?: Partial<SwizzleCLIOptions>): Promise<void>;

package/lib/commands/swizzle/index.js

@@ -8,6 +8,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.swizzle = void 0;
 const tslib_1 = require("tslib");
+const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const themes_1 = require("./themes");
 const components_1 = require("./components");
@@ -57,7 +58,8 @@ If you want to swizzle it, use the code=${'--danger'} flag, or confirm that you
     }
     return undefined;
 }
-async function swizzle(siteDir, themeNameParam, componentNameParam, optionsParam) {
+async function swizzle(themeNameParam = undefined, componentNameParam = undefined, siteDirParam = '.', optionsParam = {}) {
+    const siteDir = await fs_extra_1.default.realpath(siteDirParam);
     const options = (0, common_1.normalizeOptions)(optionsParam);
     const { list, danger, typescript } = options;
     const { plugins } = await (0, context_1.initSwizzleContext)(siteDir);

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[] | undefined, options: WriteHeadingIDOptions): Promise<void>;
+export declare function writeHeadingIds(siteDirParam?: string, files?: string[], options?: WriteHeadingIDOptions): Promise<void>;

package/lib/commands/writeHeadingIds.js

@@ -34,7 +34,8 @@ async function getPathsToWatch(siteDir) {
     const plugins = await (0, init_1.initPlugins)(context);
     return plugins.flatMap((plugin) => plugin.getPathsToWatch?.() ?? []);
 }
-async function writeHeadingIds(siteDir, files, options) {
+async function writeHeadingIds(siteDirParam = '.', files = [], options = {}) {
+    const siteDir = await fs_extra_1.default.realpath(siteDirParam);
     const markdownFiles = await (0, utils_2.safeGlobby)(files ?? (await getPathsToWatch(siteDir)), {
         expandDirectories: ['**/*.{md,mdx}'],
     });

package/lib/commands/writeTranslations.d.ts

@@ -7,4 +7,4 @@
 import { type LoadContextOptions } from '../server';
 import { type WriteTranslationsOptions } from '../server/translations/translations';
 export declare type WriteTranslationsCLIOptions = Pick<LoadContextOptions, 'config' | 'locale'> & WriteTranslationsOptions;
-export declare function writeTranslations(siteDir: string, options: Partial<WriteTranslationsCLIOptions>): Promise<void>;
+export declare function writeTranslations(siteDirParam?: string, options?: Partial<WriteTranslationsCLIOptions>): Promise<void>;

package/lib/commands/writeTranslations.js

@@ -8,6 +8,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.writeTranslations = 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"));
 const server_1 = require("../server");
 const init_1 = require("../server/plugins/init");
@@ -46,7 +47,8 @@ async function writePluginTranslationFiles({ localizationDir, plugin, options, }
         }));
     }
 }
-async function writeTranslations(siteDir, options) {
+async function writeTranslations(siteDirParam = '.', options = {}) {
+    const siteDir = await fs_extra_1.default.realpath(siteDirParam);
     const context = await (0, server_1.loadContext)({
         siteDir,
         config: options.config,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "0.0.0-5121",
+  "version": "0.0.0-5124",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -43,13 +43,13 @@
     "@babel/runtime": "^7.18.3",
     "@babel/runtime-corejs3": "^7.18.3",
     "@babel/traverse": "^7.18.2",
-    "@docusaurus/cssnano-preset": "0.0.0-5121",
-    "@docusaurus/logger": "0.0.0-5121",
-    "@docusaurus/mdx-loader": "0.0.0-5121",
+    "@docusaurus/cssnano-preset": "0.0.0-5124",
+    "@docusaurus/logger": "0.0.0-5124",
+    "@docusaurus/mdx-loader": "0.0.0-5124",
     "@docusaurus/react-loadable": "5.5.2",
-    "@docusaurus/utils": "0.0.0-5121",
-    "@docusaurus/utils-common": "0.0.0-5121",
-    "@docusaurus/utils-validation": "0.0.0-5121",
+    "@docusaurus/utils": "0.0.0-5124",
+    "@docusaurus/utils-common": "0.0.0-5124",
+    "@docusaurus/utils-validation": "0.0.0-5124",
     "@slorber/static-site-generator-webpack-plugin": "^4.0.7",
     "@svgr/webpack": "^6.2.1",
     "autoprefixer": "^10.4.7",
@@ -106,8 +106,8 @@
     "webpackbar": "^5.0.2"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-5121",
-    "@docusaurus/types": "0.0.0-5121",
+    "@docusaurus/module-type-aliases": "0.0.0-5124",
+    "@docusaurus/types": "0.0.0-5124",
     "@types/detect-port": "^1.3.2",
     "@types/react-dom": "^18.0.5",
     "@types/react-router-config": "^5.0.6",
@@ -127,5 +127,5 @@
   "engines": {
     "node": ">=16.14"
   },
-  "gitHead": "70d9c6badffc9f018d8ead96c973ffbc4eefd069"
+  "gitHead": "dba5e8d5a7bc07b946888664f9cc3f07564093e1"
 }