@docusaurus/core 2.0.0-beta.13 → 2.0.0-beta.15

package/lib/commands/build.js

@@ -7,7 +7,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
+const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
 const copy_webpack_plugin_1 = (0, tslib_1.__importDefault)(require("copy-webpack-plugin"));
 const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
 const path_1 = (0, tslib_1.__importDefault)(require("path"));
@@ -23,14 +23,16 @@ const CleanWebpackPlugin_1 = (0, tslib_1.__importDefault)(require("../webpack/pl
 const i18n_1 = require("../server/i18n");
 const utils_2 = require("@docusaurus/utils");
 async function build(siteDir, cliOptions = {}, 
-// TODO what's the purpose of this arg ?
+// 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) {
     ['SIGINT', 'SIGTERM'].forEach((sig) => {
         process.on(sig, () => process.exit());
     });
     async function tryToBuildLocale({ locale, isLastLocale, }) {
         try {
-            // console.log(chalk.green(`Site successfully built in locale=${locale}`));
             return await buildLocale({
                 siteDir,
                 locale,
@@ -40,7 +42,7 @@ forceTerminate = true) {
             });
         }
         catch (e) {
-            console.error(`Unable to build website for locale "${locale}".`);
+            logger_1.default.error `Unable to build website for locale name=${locale}.`;
             throw e;
         }
     }
@@ -58,16 +60,15 @@ forceTerminate = true) {
     }
     else {
         if (i18n.locales.length > 1) {
-            console.log(chalk_1.default.yellow(`\nWebsite will be built for all these locales:
-- ${i18n.locales.join('\n- ')}`));
+            logger_1.default.info `Website will be built for all these locales: ${i18n.locales}`;
         }
         // We need the default locale to always be the 1st in the list
-        // If we build it last, it would "erase" the localized sites built in subfolders
+        // If we build it last, it would "erase" the localized sites built in sub-folders
         const orderedLocales = [
             i18n.defaultLocale,
             ...i18n.locales.filter((locale) => locale !== i18n.defaultLocale),
         ];
-        const results = await (0, utils_2.mapAsyncSequencial)(orderedLocales, (locale) => {
+        const results = await (0, utils_2.mapAsyncSequential)(orderedLocales, (locale) => {
             const isLastLocale = orderedLocales.indexOf(locale) === orderedLocales.length - 1;
             return tryToBuildLocale({ locale, isLastLocale });
         });
@@ -78,7 +79,7 @@ exports.default = build;
 async function buildLocale({ siteDir, locale, cliOptions, forceTerminate, isLastLocale, }) {
     process.env.BABEL_ENV = 'production';
     process.env.NODE_ENV = 'production';
-    console.log(chalk_1.default.blue(`\n[${locale}] Creating an optimized production build...`));
+    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,
@@ -92,7 +93,7 @@ async function buildLocale({ siteDir, locale, cliOptions, forceTerminate, isLast
         plugins: [
             // Remove/clean build folders before building bundles.
             new CleanWebpackPlugin_1.default({ verbose: false }),
-            // Visualize size of webpack output files with an interactive zoomable treemap.
+            // Visualize size of webpack output files with an interactive zoomable tree map.
             cliOptions.bundleAnalyzer && new webpack_bundle_analyzer_1.BundleAnalyzerPlugin(),
             // Generate client manifests file that will be used for server bundle.
             new react_loadable_ssr_addon_v5_slorber_1.default({
@@ -125,9 +126,9 @@ async function buildLocale({ siteDir, locale, cliOptions, forceTerminate, isLast
             clientConfig = (0, utils_1.applyConfigurePostCss)(configurePostCss, clientConfig);
         }
         if (configureWebpack) {
-            clientConfig = (0, utils_1.applyConfigureWebpack)(configureWebpack.bind(plugin), // The plugin lifecycle may reference `this`. // TODO remove this implicit api: inject in callback instead
+            clientConfig = (0, utils_1.applyConfigureWebpack)(configureWebpack.bind(plugin), // The plugin lifecycle may reference `this`.
             clientConfig, false, (_a = props.siteConfig.webpack) === null || _a === void 0 ? void 0 : _a.jsLoader, plugin.content);
-            serverConfig = (0, utils_1.applyConfigureWebpack)(configureWebpack.bind(plugin), // The plugin lifecycle may reference `this`. // TODO remove this implicit api: inject in callback instead
+            serverConfig = (0, utils_1.applyConfigureWebpack)(configureWebpack.bind(plugin), // The plugin lifecycle may reference `this`.
             serverConfig, true, (_b = props.siteConfig.webpack) === null || _b === void 0 ? void 0 : _b.jsLoader, plugin.content);
         }
     });
@@ -152,7 +153,8 @@ async function buildLocale({ siteDir, locale, cliOptions, forceTerminate, isLast
         if (!plugin.postBuild) {
             return;
         }
-        await plugin.postBuild(props);
+        // The plugin may reference `this`. We manually bind it again to prevent any bugs.
+        await plugin.postBuild({ ...props, content: plugin.content });
     }));
     await (0, brokenLinks_1.handleBrokenLinks)({
         allCollectedLinks,
@@ -161,9 +163,9 @@ async function buildLocale({ siteDir, locale, cliOptions, forceTerminate, isLast
         outDir,
         baseUrl,
     });
-    console.log(`${chalk_1.default.green(`Success!`)} Generated static files in "${chalk_1.default.cyan(path_1.default.relative(process.cwd(), outDir))}".`);
+    logger_1.default.success `Generated static files in path=${path_1.default.relative(process.cwd(), outDir)}.`;
     if (isLastLocale) {
-        console.log(`\nUse ${chalk_1.default.greenBright('`npm run serve`')} command to test your build locally.\n`);
+        logger_1.default.info `Use code=${'npm run serve'} command to test your build locally.`;
     }
     if (forceTerminate && isLastLocale && !cliOptions.bundleAnalyzer) {
         process.exit(0);

package/lib/commands/clear.js

@@ -9,18 +9,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
 const path_1 = (0, tslib_1.__importDefault)(require("path"));
-const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
+const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
 const utils_1 = require("@docusaurus/utils");
-function removePath(fsPath) {
-    return fs_extra_1.default
-        .remove(path_1.default.join(fsPath))
-        .then(() => {
-        console.log(chalk_1.default.green(`Successfully removed "${fsPath}" directory.`));
-    })
-        .catch((err) => {
-        console.error(`Could not remove ${fsPath} directory.`);
-        console.error(err);
-    });
+async function removePath(fsPath) {
+    try {
+        fs_extra_1.default.remove(path_1.default.join(fsPath));
+        logger_1.default.success `Removed the path=${fsPath} directory.`;
+    }
+    catch (e) {
+        logger_1.default.error `Could not remove path=${fsPath} directory.
+${e}`;
+    }
 }
 async function clear(siteDir) {
     return Promise.all([

package/lib/commands/commandUtils.d.ts

@@ -4,6 +4,6 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { HostPortCLIOptions } from '@docusaurus/types';
+import type { HostPortCLIOptions } from '@docusaurus/types';
 export declare function getCLIOptionHost(hostOption: HostPortCLIOptions['host']): string;
 export declare function getCLIOptionPort(portOption: HostPortCLIOptions['port'], host: string): Promise<number | null>;

package/lib/commands/deploy.d.ts

@@ -4,7 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { BuildCLIOptions } from '@docusaurus/types';
+import type { BuildCLIOptions } from '@docusaurus/types';
 export declare function buildSshUrl(githubHost: string, organizationName: string, projectName: string, githubPort?: string): string;
 export declare function buildHttpsUrl(gitCredentials: string, githubHost: string, organizationName: string, projectName: string, githubPort?: string): string;
 export declare function hasSSHProtocol(sourceRepoUrl: string): boolean;

package/lib/commands/deploy.js

@@ -10,7 +10,7 @@ exports.hasSSHProtocol = exports.buildHttpsUrl = exports.buildSshUrl = void 0;
 const tslib_1 = require("tslib");
 const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
 const shelljs_1 = (0, tslib_1.__importDefault)(require("shelljs"));
-const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
+const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
 const server_1 = require("../server");
 const build_1 = (0, tslib_1.__importDefault)(require("./build"));
 const path_1 = (0, tslib_1.__importDefault)(require("path"));
@@ -25,11 +25,11 @@ function obfuscateGitPass(str) {
 function shellExecLog(cmd) {
     try {
         const result = shelljs_1.default.exec(cmd);
-        console.log(`${chalk_1.default.cyan('CMD:')} ${obfuscateGitPass(cmd)} ${chalk_1.default.cyan(`(code: ${result.code})`)}`);
+        logger_1.default.info `code=${obfuscateGitPass(cmd)} subdue=${`code: ${result.code}`}`;
         return result;
     }
     catch (e) {
-        console.log(`${chalk_1.default.red('CMD:')} ${obfuscateGitPass(cmd)}`);
+        logger_1.default.error `code=${obfuscateGitPass(cmd)}`;
         throw e;
     }
 }
@@ -66,14 +66,12 @@ async function deploy(siteDir, cliOptions = {}) {
         customOutDir: cliOptions.outDir,
     });
     if (typeof siteConfig.trailingSlash === 'undefined') {
-        console.warn(chalk_1.default.yellow(`
-Docusaurus recommendation:
-When deploying to GitHub Pages, it is better to use an explicit "trailingSlash" site config.
+        logger_1.default.warn(`When deploying to GitHub Pages, it is better to use an explicit "trailingSlash" site config.
 Otherwise, GitHub Pages will add an extra trailing slash to your site urls only on direct-access (not when navigation) with a server redirect.
 This behavior can have SEO impacts and create relative link issues.
-`));
+`);
     }
-    console.log('Deploy command invoked...');
+    logger_1.default.info('Deploy command invoked...');
     if (!shelljs_1.default.which('git')) {
         throw new Error('Git not installed or on the PATH!');
     }
@@ -102,14 +100,14 @@ This behavior can have SEO impacts and create relative link issues.
     if (!organizationName) {
         throw new Error(`Missing project organization name. Did you forget to define "organizationName" in ${siteConfigPath}? You may also export it via the ORGANIZATION_NAME environment variable.`);
     }
-    console.log(`${chalk_1.default.cyan('organizationName:')} ${organizationName}`);
+    logger_1.default.info `organizationName: name=${organizationName}`;
     const projectName = process.env.PROJECT_NAME ||
         process.env.CIRCLE_PROJECT_REPONAME ||
         siteConfig.projectName;
     if (!projectName) {
         throw new Error(`Missing project name. Did you forget to define "projectName" in ${siteConfigPath}? You may also export it via the PROJECT_NAME environment variable.`);
     }
-    console.log(`${chalk_1.default.cyan('projectName:')} ${projectName}`);
+    logger_1.default.info `projectName: name=${projectName}`;
     // We never deploy on pull request.
     const isPullRequest = process.env.CI_PULL_REQUEST || process.env.CIRCLE_PULL_REQUEST;
     if (isPullRequest) {
@@ -129,7 +127,7 @@ Please provide the branch name to deploy to as an environment variable, for exam
 You can also set the deploymentBranch property in docusaurus.config.js .`);
     }
     const deploymentBranch = process.env.DEPLOYMENT_BRANCH || siteConfig.deploymentBranch || 'gh-pages';
-    console.log(`${chalk_1.default.cyan('deploymentBranch:')} ${deploymentBranch}`);
+    logger_1.default.info `deploymentBranch: name=${deploymentBranch}`;
     const githubHost = process.env.GITHUB_HOST || siteConfig.githubHost || 'github.com';
     const githubPort = process.env.GITHUB_PORT || siteConfig.githubPort;
     let deploymentRepoURL;
@@ -141,7 +139,7 @@ You can also set the deploymentBranch property in docusaurus.config.js .`);
         const gitCredentials = gitPass ? `${gitUser}:${gitPass}` : gitUser;
         deploymentRepoURL = buildHttpsUrl(gitCredentials, githubHost, organizationName, projectName, githubPort);
     }
-    console.log(`${chalk_1.default.cyan('Remote repo URL:')} ${obfuscateGitPass(deploymentRepoURL)}`);
+    logger_1.default.info `Remote repo URL: name=${obfuscateGitPass(deploymentRepoURL)}`;
     // Check if this is a cross-repo publish.
     const crossRepoPublish = !sourceRepoUrl.endsWith(`${organizationName}/${projectName}.git`);
     // We don't allow deploying to the same branch unless it's a cross publish.
@@ -160,7 +158,7 @@ You can also set the deploymentBranch property in docusaurus.config.js .`);
         // the files in the directory. If the 'clone' command fails, assume that
         // the deployment branch doesn't exist, and initialize git in an empty
         // directory, check out a clean deployment branch and add remote.
-        if (shellExecLog(`git clone --depth 1 --branch ${deploymentBranch} ${deploymentRepoURL} ${toPath}`).code === 0) {
+        if (shellExecLog(`git clone --depth 1 --branch ${deploymentBranch} ${deploymentRepoURL} "${toPath}"`).code === 0) {
             shellExecLog('git rm -rf .');
         }
         else {
@@ -203,7 +201,7 @@ You can also set the deploymentBranch property in docusaurus.config.js .`);
             await runDeploy(await (0, build_1.default)(siteDir, cliOptions, false));
         }
         catch (buildError) {
-            console.error(buildError);
+            logger_1.default.error(buildError.message);
             process.exit(1);
         }
     }

package/lib/commands/external.d.ts

@@ -4,5 +4,5 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { Command } from 'commander';
+import type { Command } from 'commander';
 export default function externalCommand(cli: Command, siteDir: string): Promise<void>;

package/lib/commands/external.js

@@ -12,7 +12,7 @@ const init_1 = (0, tslib_1.__importDefault)(require("../server/plugins/init"));
 async function externalCommand(cli, siteDir) {
     const context = await (0, server_1.loadContext)(siteDir);
     const pluginConfigs = (0, server_1.loadPluginConfigs)(context);
-    const plugins = (0, init_1.default)({ pluginConfigs, context });
+    const plugins = await (0, init_1.default)({ pluginConfigs, context });
     // Plugin Lifecycle - extendCli.
     plugins.forEach((plugin) => {
         const { extendCli } = plugin;

package/lib/commands/serve.d.ts

@@ -4,5 +4,5 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { ServeCLIOptions } from '@docusaurus/types';
+import type { ServeCLIOptions } from '@docusaurus/types';
 export default function serve(siteDir: string, cliOptions: ServeCLIOptions): Promise<void>;

package/lib/commands/serve.js

@@ -9,8 +9,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const http_1 = (0, tslib_1.__importDefault)(require("http"));
 const serve_handler_1 = (0, tslib_1.__importDefault)(require("serve-handler"));
-const boxen_1 = (0, tslib_1.__importDefault)(require("boxen"));
-const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
+const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
 const path_1 = (0, tslib_1.__importDefault)(require("path"));
 const server_1 = require("../server");
 const build_1 = (0, tslib_1.__importDefault)(require("./build"));
@@ -54,12 +53,7 @@ async function serve(siteDir, cliOptions) {
             trailingSlash,
         });
     });
-    console.log((0, boxen_1.default)(chalk_1.default.green(`Serving "${cliOptions.dir}" directory at "${servingUrl + baseUrl}".`), {
-        borderColor: 'green',
-        padding: 1,
-        margin: 1,
-        align: 'center',
-    }));
+    logger_1.default.success `Serving path=${cliOptions.dir} directory at path=${servingUrl + baseUrl}.`;
     server.listen(port);
 }
 exports.default = serve;

package/lib/commands/start.d.ts

@@ -4,5 +4,5 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { StartCLIOptions } from '@docusaurus/types';
+import type { StartCLIOptions } from '@docusaurus/types';
 export default function start(siteDir: string, cliOptions: Partial<StartCLIOptions>): Promise<void>;

package/lib/commands/start.js

@@ -8,7 +8,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const utils_1 = require("@docusaurus/utils");
-const chalk = require("chalk");
+const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
 const chokidar_1 = (0, tslib_1.__importDefault)(require("chokidar"));
 const html_webpack_plugin_1 = (0, tslib_1.__importDefault)(require("html-webpack-plugin"));
 const path_1 = (0, tslib_1.__importDefault)(require("path"));
@@ -27,7 +27,7 @@ const translations_1 = require("../server/translations/translations");
 async function start(siteDir, cliOptions) {
     process.env.NODE_ENV = 'development';
     process.env.BABEL_ENV = 'development';
-    console.log(chalk.blue('Starting the development server...'));
+    logger_1.default.info('Starting the development server...');
     function loadSite() {
         return (0, server_1.load)(siteDir, {
             customConfigFilePath: cliOptions.config,
@@ -46,18 +46,18 @@ async function start(siteDir, cliOptions) {
     const { baseUrl, headTags, preBodyTags, postBodyTags } = props;
     const urls = (0, WebpackDevServerUtils_1.prepareUrls)(protocol, host, port);
     const openUrl = (0, utils_1.normalizeUrl)([urls.localUrlForBrowser, baseUrl]);
-    console.log(chalk.cyanBright(`Docusaurus website is running at "${openUrl}".`));
+    logger_1.default.success `Docusaurus website is running at path=${openUrl}.`;
     // Reload files processing.
     const reload = (0, lodash_1.debounce)(() => {
         loadSite()
             .then(({ baseUrl: newBaseUrl }) => {
             const newOpenUrl = (0, utils_1.normalizeUrl)([urls.localUrlForBrowser, newBaseUrl]);
             if (newOpenUrl !== openUrl) {
-                console.log(chalk.cyanBright(`Docusaurus website is running at "${newOpenUrl}".`));
+                logger_1.default.success `Docusaurus website is running at path=${newOpenUrl}.`;
             }
         })
             .catch((err) => {
-            console.error(chalk.red(err.stack));
+            logger_1.default.error(err.stack);
         });
     }, 500);
     const { siteConfig, plugins = [] } = props;
@@ -101,7 +101,7 @@ async function start(siteDir, cliOptions) {
         plugins: [
             // Generates an `index.html` file with the <script> injected.
             new html_webpack_plugin_1.default({
-                template: path_1.default.resolve(__dirname, '../client/templates/index.html.template.ejs'),
+                template: path_1.default.resolve(__dirname, '../webpack/templates/index.html.template.ejs'),
                 // So we can define the position where the scripts are injected.
                 inject: false,
                 filename: 'index.html',
@@ -124,8 +124,19 @@ async function start(siteDir, cliOptions) {
             config, false, (_a = props.siteConfig.webpack) === null || _a === void 0 ? void 0 : _a.jsLoader, plugin.content);
         }
     });
+    const compiler = (0, webpack_1.default)(config);
+    if (process.env.E2E_TEST) {
+        compiler.hooks.done.tap('done', (stats) => {
+            if (stats.hasErrors()) {
+                logger_1.default.error('E2E_TEST: Project has compiler errors.');
+                process.exit(1);
+            }
+            logger_1.default.success('E2E_TEST: Project can compile.');
+            process.exit(0);
+        });
+    }
     // https://webpack.js.org/configuration/dev-server
-    const devServerConfig = {
+    const defaultDevServerConfig = {
         hot: cliOptions.hotOnly ? 'only' : true,
         liveReload: false,
         client: {
@@ -168,24 +179,14 @@ async function start(siteDir, cliOptions) {
         allowedHosts: 'all',
         host,
         port,
-        onBeforeSetupMiddleware: (devServer) => {
+        setupMiddlewares: (middlewares, devServer) => {
             // This lets us fetch source contents from webpack for the error overlay.
-            devServer.app.use((0, evalSourceMapMiddleware_1.default)(
-            // @ts-expect-error: bad types
-            devServer));
+            middlewares.unshift((0, evalSourceMapMiddleware_1.default)(devServer));
+            return middlewares;
         },
     };
-    const compiler = (0, webpack_1.default)(config);
-    if (process.env.E2E_TEST) {
-        compiler.hooks.done.tap('done', (stats) => {
-            if (stats.hasErrors()) {
-                console.log('E2E_TEST: Project has compiler errors.');
-                process.exit(1);
-            }
-            console.log('E2E_TEST: Project can compile.');
-            process.exit(0);
-        });
-    }
+    // Allow plugin authors to customize/override devServer config
+    const devServerConfig = (0, webpack_merge_1.default)([defaultDevServerConfig, config.devServer].filter(Boolean));
     const devServer = new webpack_dev_server_1.default(devServerConfig, compiler);
     devServer.startCallback(() => {
         if (cliOptions.open) {

package/lib/commands/swizzle.d.ts

@@ -4,6 +4,6 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { PluginConfig } from '@docusaurus/types';
+import type { PluginConfig } from '@docusaurus/types';
 export declare function getPluginNames(plugins: PluginConfig[]): string[];
 export default function swizzle(siteDir: string, themeName?: string, componentName?: string, typescript?: boolean, danger?: boolean): Promise<void>;

package/lib/commands/swizzle.js

@@ -8,7 +8,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getPluginNames = void 0;
 const tslib_1 = require("tslib");
-const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
+const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
 const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
 const import_fresh_1 = (0, tslib_1.__importDefault)(require("import-fresh"));
 const path_1 = (0, tslib_1.__importDefault)(require("path"));
@@ -82,20 +82,16 @@ function getComponentName(themePath, plugin, danger) {
 function themeComponents(themePath, plugin) {
     const components = colorCode(themePath, plugin);
     if (components.length === 0) {
-        return `${chalk_1.default.red('No component to swizzle.')}`;
+        return 'No component to swizzle.';
     }
-    return `
-${chalk_1.default.cyan('Theme components available for swizzle.')}
+    return `Theme components available for swizzle.
 
-${chalk_1.default.green('green  =>')} safe: lower breaking change risk
-${chalk_1.default.red('red    =>')} unsafe: higher breaking change risk
+${logger_1.default.green(logger_1.default.bold('green  =>'))} safe: lower breaking change risk
+${logger_1.default.red(logger_1.default.bold('red    =>'))} unsafe: higher breaking change risk
 
 ${components.join('\n')}
 `;
 }
-function formattedThemeNames(themeNames) {
-    return `Themes available for swizzle:\n- ${themeNames.join('\n- ')}`;
-}
 function colorCode(themePath, plugin) {
     var _a, _b;
     // support both commonjs and ES style exports
@@ -106,8 +102,8 @@ function colorCode(themePath, plugin) {
         : [];
     const [greenComponents, redComponents] = (0, lodash_1.partition)(components, (comp) => allowedComponent.includes(comp));
     return [
-        ...greenComponents.map((component) => chalk_1.default.green(`safe: ${component}`)),
-        ...redComponents.map((component) => chalk_1.default.red(`unsafe: ${component}`)),
+        ...greenComponents.map((component) => `${logger_1.default.green(logger_1.default.bold('safe:'))}   ${component}`),
+        ...redComponents.map((component) => `${logger_1.default.red(logger_1.default.bold('unsafe:'))} ${component}`),
     ];
 }
 async function swizzle(siteDir, themeName, componentName, typescript, danger) {
@@ -115,7 +111,7 @@ async function swizzle(siteDir, themeName, componentName, typescript, danger) {
     const context = await (0, server_1.loadContext)(siteDir);
     const pluginConfigs = (0, server_1.loadPluginConfigs)(context);
     const pluginNames = getPluginNames(pluginConfigs);
-    const plugins = (0, init_1.default)({
+    const plugins = await (0, init_1.default)({
         pluginConfigs,
         context,
     });
@@ -123,8 +119,8 @@ async function swizzle(siteDir, themeName, componentName, typescript, danger) {
         ? plugins[index].getTypeScriptThemePath
         : plugins[index].getThemePath);
     if (!themeName) {
-        console.log(formattedThemeNames(themeNames));
-        process.exit(1);
+        logger_1.default.info `Themes available for swizzle: name=${themeNames}`;
+        return;
     }
     let pluginModule;
     try {
@@ -137,9 +133,9 @@ async function swizzle(siteDir, themeName, componentName, typescript, danger) {
                 suggestion = name;
             }
         });
-        chalk_1.default.red(`Theme ${themeName} not found. ${suggestion
-            ? `Did you mean "${suggestion}" ?`
-            : formattedThemeNames(themeNames)}`);
+        logger_1.default.error `Theme name=${themeName} not found. ${suggestion
+            ? logger_1.default.interpolate `Did you mean name=${suggestion}?`
+            : logger_1.default.interpolate `Themes available for swizzle: ${themeNames}`}`;
         process.exit(1);
     }
     let pluginOptions = {};
@@ -166,19 +162,19 @@ async function swizzle(siteDir, themeName, componentName, typescript, danger) {
     }
     // support both commonjs and ES style exports
     const plugin = (_c = pluginModule.default) !== null && _c !== void 0 ? _c : pluginModule;
-    const pluginInstance = plugin(context, pluginOptions);
+    const pluginInstance = await plugin(context, pluginOptions);
     const themePath = typescript
         ? (_d = pluginInstance.getTypeScriptThemePath) === null || _d === void 0 ? void 0 : _d.call(pluginInstance)
         : (_e = pluginInstance.getThemePath) === null || _e === void 0 ? void 0 : _e.call(pluginInstance);
     if (!themePath) {
-        console.warn(chalk_1.default.yellow(typescript
-            ? `${themeName} does not provide TypeScript theme code via "getTypeScriptThemePath()".`
-            : `${themeName} does not provide any theme code.`));
+        logger_1.default.warn(typescript
+            ? logger_1.default.interpolate `name=${themeName} does not provide TypeScript theme code via ${'getTypeScriptThemePath()'}.`
+            : logger_1.default.interpolate `name=${themeName} does not provide any theme code.`);
         process.exit(1);
     }
     if (!componentName) {
-        console.warn(themeComponents(themePath, pluginModule));
-        process.exit(1);
+        logger_1.default.info(themeComponents(themePath, pluginModule));
+        return;
     }
     const components = getComponentName(themePath, pluginModule, Boolean(danger));
     const formattedComponentName = formatComponentName(componentName);
@@ -199,7 +195,8 @@ async function swizzle(siteDir, themeName, componentName, typescript, danger) {
         });
         if (mostSuitableMatch !== componentName) {
             mostSuitableComponent = mostSuitableMatch;
-            console.log(chalk_1.default.red(`Component "${componentName}" doesn't exist.`), chalk_1.default.yellow(`"${mostSuitableComponent}" is swizzled instead of "${componentName}".`));
+            logger_1.default.error `Component name=${componentName} doesn't exist.`;
+            logger_1.default.info `name=${mostSuitableComponent} is swizzled instead of name=${componentName}.`;
         }
     }
     let fromPath = path_1.default.join(themePath, mostSuitableComponent);
@@ -223,23 +220,17 @@ async function swizzle(siteDir, themeName, componentName, typescript, danger) {
                     suggestion = name;
                 }
             });
-            console.warn(chalk_1.default.red(`Component ${mostSuitableComponent} not found.`));
-            console.warn(suggestion
-                ? `Did you mean "${suggestion}"?`
-                : `${themeComponents(themePath, pluginModule)}`);
+            logger_1.default.error `Component name=${mostSuitableComponent} not found. ${suggestion
+                ? logger_1.default.interpolate `Did you mean name=${suggestion} ?`
+                : themeComponents(themePath, pluginModule)}`;
             process.exit(1);
         }
     }
     if (!components.includes(mostSuitableComponent) && !danger) {
-        console.warn(chalk_1.default.red(`${mostSuitableComponent} is an internal component and has a higher breaking change probability. If you want to swizzle it, use the "--danger" flag.`));
+        logger_1.default.error `name=${mostSuitableComponent} is an internal component and has a higher breaking change probability. If you want to swizzle it, use the code=${'--danger'} flag.`;
         process.exit(1);
     }
     await fs_extra_1.default.copy(fromPath, toPath);
-    const relativeDir = path_1.default.relative(process.cwd(), toPath);
-    const fromMsg = chalk_1.default.blue(mostSuitableComponent
-        ? `${themeName} ${chalk_1.default.yellow(mostSuitableComponent)}`
-        : themeName);
-    const toMsg = chalk_1.default.cyan(relativeDir);
-    console.log(`\n${chalk_1.default.green('Success!')} Copied ${fromMsg} to ${toMsg}.\n`);
+    logger_1.default.success `Copied code=${mostSuitableComponent ? `${themeName} ${mostSuitableComponent}` : themeName} to path=${path_1.default.relative(process.cwd(), toPath)}.`;
 }
 exports.default = swizzle;

package/lib/commands/writeHeadingIds.d.ts

@@ -4,7 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { Slugger } from '@docusaurus/utils';
+import { type Slugger } from '@docusaurus/utils';
 declare type Options = {
     maintainCase?: boolean;
     overwrite?: boolean;

package/lib/commands/writeHeadingIds.js

@@ -9,7 +9,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.transformMarkdownContent = exports.transformMarkdownHeadingLine = void 0;
 const tslib_1 = require("tslib");
 const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
-const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
+const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
 const server_1 = require("../server");
 const init_1 = (0, tslib_1.__importDefault)(require("../server/plugins/init"));
 const utils_1 = require("@docusaurus/utils");
@@ -87,7 +87,7 @@ async function transformMarkdownFile(filepath, options) {
 async function getPathsToWatch(siteDir) {
     const context = await (0, server_1.loadContext)(siteDir);
     const pluginConfigs = (0, server_1.loadPluginConfigs)(context);
-    const plugins = (0, init_1.default)({
+    const plugins = await (0, init_1.default)({
         pluginConfigs,
         context,
     });
@@ -100,11 +100,10 @@ async function writeHeadingIds(siteDir, files, options) {
     const result = await Promise.all(markdownFiles.map((p) => transformMarkdownFile(p, options)));
     const pathsModified = result.filter(Boolean);
     if (pathsModified.length) {
-        console.log(chalk_1.default.green(`Heading ids added to Markdown files (${pathsModified.length}/${markdownFiles.length} files):
-- ${pathsModified.join('\n- ')}`));
+        logger_1.default.success `Heading ids added to Markdown files (number=${`${pathsModified.length}/${markdownFiles.length}`} files): ${pathsModified}`;
     }
     else {
-        console.log(chalk_1.default.yellow(`${markdownFiles.length} Markdown files already have explicit heading IDs. If you intend to overwrite the existing heading IDs, use the ${chalk_1.default.cyan('--overwrite')} option.`));
+        logger_1.default.warn `number=${markdownFiles.length} Markdown files already have explicit heading IDs. If you intend to overwrite the existing heading IDs, use the code=${'--overwrite'} option.`;
     }
 }
 exports.default = writeHeadingIds;

package/lib/commands/writeTranslations.d.ts

@@ -4,8 +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 { ConfigOptions } from '@docusaurus/types';
-import { WriteTranslationsOptions } from '../server/translations/translations';
+import type { ConfigOptions } from '@docusaurus/types';
+import { type WriteTranslationsOptions } from '../server/translations/translations';
 export default function writeTranslations(siteDir: string, options: WriteTranslationsOptions & ConfigOptions & {
     locale?: string;
 }): Promise<void>;

package/lib/commands/writeTranslations.js

@@ -51,7 +51,7 @@ async function writeTranslations(siteDir, options) {
         locale: options.locale,
     });
     const pluginConfigs = (0, server_1.loadPluginConfigs)(context);
-    const plugins = (0, init_1.default)({
+    const plugins = await (0, init_1.default)({
         pluginConfigs,
         context,
     });

package/lib/server/brokenLinks.d.ts

@@ -4,7 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { RouteConfig, ReportingSeverity } from '@docusaurus/types';
+import type { RouteConfig, ReportingSeverity } from '@docusaurus/types';
 declare type BrokenLink = {
     link: string;
     resolvedLink: string;