@docusaurus/core 0.0.0-4630 → 0.0.0-4633

package/bin/beforeCli.mjs

@@ -61,9 +61,9 @@ export default async function beforeCli() {
       notifier.config.set('lastUpdateCheck', 0);
       notifier.check();
     }
-  } catch (e) {
+  } catch (err) {
     // Do not stop cli if this fails, see https://github.com/facebook/docusaurus/issues/5400
-    logger.error(e);
+    logger.error(err);
   }
 
   /**

package/bin/docusaurus.mjs

@@ -68,20 +68,28 @@ cli
 
 cli
   .command('swizzle [themeName] [componentName] [siteDir]')
-  .description('Copy the theme files into website folder for customization.')
+  .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(
-    '--typescript',
+    '-t, --typescript',
     'copy TypeScript theme files when possible (default: false)',
   )
-  .option('--danger', 'enable swizzle for internal component of themes')
-  .action(async (themeName, componentName, siteDir, {typescript, danger}) => {
-    swizzle(
-      await resolveDir(siteDir),
-      themeName,
-      componentName,
-      typescript,
-      danger,
-    );
+  .option('--danger', 'enable swizzle for unsafe component of themes')
+  .action(async (themeName, componentName, siteDir, options) => {
+    swizzle(await resolveDir(siteDir), themeName, componentName, options);
   });
 
 cli

package/lib/choosePort.js

@@ -55,7 +55,7 @@ function getProcessForPort(port) {
         const command = getProcessCommand(processId);
         return logger_1.default.interpolate `code=${command} subdue=${`(pid ${processId})`} in path=${directory}`;
     }
-    catch (e) {
+    catch {
         return null;
     }
 }
@@ -64,41 +64,33 @@ function getProcessForPort(port) {
  * to choose another if port is already being used
  */
 async function choosePort(host, defaultPort) {
-    return (0, detect_port_1.default)({ port: defaultPort, hostname: host }).then((port) => new Promise((resolve) => {
+    try {
+        const port = await (0, detect_port_1.default)({ port: defaultPort, hostname: host });
         if (port === defaultPort) {
-            resolve(port);
-            return;
+            return port;
         }
         const message = process.platform !== 'win32' && defaultPort < 1024 && !(0, is_root_1.default)()
             ? `Admin permissions are required to run a server on a port below 1024.`
             : `Something is already running on port ${defaultPort}.`;
-        if (isInteractive) {
-            clearConsole();
-            const existingProcess = getProcessForPort(defaultPort);
-            const question = {
-                type: 'confirm',
-                name: 'shouldChangePort',
-                message: logger_1.default.yellow(`${logger_1.default.bold('[WARNING]')} ${message}${existingProcess ? ` Probably:\n  ${existingProcess}` : ''}
-
-Would you like to run the app on another port instead?`),
-                initial: true,
-            };
-            (0, prompts_1.default)(question).then((answer) => {
-                if (answer.shouldChangePort === true) {
-                    resolve(port);
-                }
-                else {
-                    resolve(null);
-                }
-            });
-        }
-        else {
+        if (!isInteractive) {
             logger_1.default.error(message);
-            resolve(null);
+            return null;
         }
-    }), (err) => {
-        throw new Error(`Could not find an open port at ${host}.
-${`Network error message: "${err.message || err}".`}`);
-    });
+        clearConsole();
+        const existingProcess = getProcessForPort(defaultPort);
+        const { shouldChangePort } = await (0, prompts_1.default)({
+            type: 'confirm',
+            name: 'shouldChangePort',
+            message: logger_1.default.yellow(`${logger_1.default.bold('[WARNING]')} ${message}${existingProcess ? ` Probably:\n  ${existingProcess}` : ''}
+
+Would you like to run the app on another port instead?`),
+            initial: true,
+        });
+        return shouldChangePort ? port : null;
+    }
+    catch (err) {
+        logger_1.default.error `Could not find an open port at ${host}.`;
+        throw err;
+    }
 }
 exports.default = choosePort;

package/lib/client/serverEntry.js

@@ -34,16 +34,15 @@ export default async function render(locals) {
     try {
         return await doRender(locals);
     }
-    catch (e) {
-        logger.error `Docusaurus Node/SSR could not render static page with path path=${locals.path} because of following error:
-${e.stack}`;
+    catch (err) {
+        logger.error `Docusaurus server-side rendering could not render static page with path path=${locals.path}.`;
         const isNotDefinedErrorRegex = /(?:window|document|localStorage|navigator|alert|location|buffer|self) is not defined/i;
-        if (isNotDefinedErrorRegex.test(e.message)) {
+        if (isNotDefinedErrorRegex.test(err.message)) {
             logger.info `It looks like you are using code that should run on the client-side only.
 To get around it, try using code=${'<BrowserOnly>'} (path=${'https://docusaurus.io/docs/docusaurus-core/#browseronly'}) or code=${'ExecutionEnvironment'} (path=${'https://docusaurus.io/docs/docusaurus-core/#executionenvironment'}).
 It might also require to wrap your client code in code=${'useEffect'} hook and/or import a third-party library dynamically (if any).`;
         }
-        throw new Error('Server-side rendering fails due to the error above.');
+        throw err;
     }
 }
 // Renderer for static-site-generator-webpack-plugin (async rendering).
@@ -110,9 +109,8 @@ async function doRender(locals) {
             minifyJS: true,
         });
     }
-    catch (e) {
-        logger.error `Minification of page path=${locals.path} failed because of following error:
-${e.stack}`;
-        throw e;
+    catch (err) {
+        logger.error `Minification of page path=${locals.path} failed.`;
+        throw err;
     }
 }

package/lib/commands/build.js

@@ -41,9 +41,9 @@ forceTerminate = true) {
                 isLastLocale,
             });
         }
-        catch (e) {
+        catch (err) {
             logger_1.default.error `Unable to build website for locale name=${locale}.`;
-            throw e;
+            throw err;
         }
     }
     const context = await (0, server_1.loadContext)(siteDir, {

package/lib/commands/clear.js

@@ -19,9 +19,9 @@ async function removePath(entry) {
         await fs_extra_1.default.remove(entry.path);
         logger_1.default.success `Removed the ${entry.description} at path=${entry.path}.`;
     }
-    catch (e) {
-        logger_1.default.error `Could not remove the ${entry.description} at path=${entry.path}.
-${e}`;
+    catch (err) {
+        logger_1.default.error `Could not remove the ${entry.description} at path=${entry.path}.`;
+        logger_1.default.error(err);
     }
 }
 async function clear(siteDir) {

package/lib/commands/deploy.js

@@ -28,9 +28,9 @@ function shellExecLog(cmd) {
         logger_1.default.info `code=${obfuscateGitPass(cmd)} subdue=${`code: ${result.code}`}`;
         return result;
     }
-    catch (e) {
+    catch (err) {
         logger_1.default.error `code=${obfuscateGitPass(cmd)}`;
-        throw e;
+        throw err;
     }
 }
 function buildSshUrl(githubHost, organizationName, projectName, githubPort) {
@@ -169,8 +169,9 @@ You can also set the deploymentBranch property in docusaurus.config.js .`);
         try {
             await fs_extra_1.default.copy(fromPath, toPath);
         }
-        catch (error) {
-            throw new Error(`Copying build assets from "${fromPath}" to "${toPath}" failed with error "${error}".`);
+        catch (err) {
+            logger_1.default.error `Copying build assets from path=${fromPath} to path=${toPath} failed.`;
+            throw err;
         }
         shellExecLog('git add --all');
         const commitMessage = process.env.CUSTOM_COMMIT_MESSAGE ||
@@ -200,9 +201,9 @@ You can also set the deploymentBranch property in docusaurus.config.js .`);
         try {
             await runDeploy(await (0, build_1.default)(siteDir, cliOptions, false));
         }
-        catch (buildError) {
-            logger_1.default.error(buildError.message);
-            process.exit(1);
+        catch (err) {
+            logger_1.default.error('Deployment of the build output failed.');
+            throw err;
         }
     }
     else {

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

@@ -0,0 +1,23 @@
+/**
+ * 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 { SwizzleAction, SwizzleComponentConfig } from '@docusaurus/types';
+import type { SwizzleOptions } from './common';
+export declare const SwizzleActions: SwizzleAction[];
+export declare function getAction(componentConfig: SwizzleComponentConfig, options: Pick<SwizzleOptions, 'wrap' | 'eject'>): Promise<SwizzleAction>;
+export declare type ActionParams = {
+    siteDir: string;
+    themePath: string;
+    componentName: string;
+};
+export declare type ActionResult = {
+    createdFiles: string[];
+};
+export declare function eject({ siteDir, themePath, componentName, }: ActionParams): Promise<ActionResult>;
+export declare function wrap({ siteDir, themePath, componentName: themeComponentName, typescript, importType, }: ActionParams & {
+    typescript: boolean;
+    importType?: 'original' | 'init';
+}): Promise<ActionResult>;

package/lib/commands/swizzle/actions.js

@@ -0,0 +1,102 @@
+"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.wrap = exports.eject = exports.getAction = exports.SwizzleActions = void 0;
+const tslib_1 = require("tslib");
+const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
+const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
+const path_1 = (0, tslib_1.__importDefault)(require("path"));
+const lodash_1 = (0, tslib_1.__importDefault)(require("lodash"));
+const utils_1 = require("@docusaurus/utils");
+const prompts_1 = require("./prompts");
+exports.SwizzleActions = ['wrap', 'eject'];
+async function getAction(componentConfig, options) {
+    if (options.wrap) {
+        return 'wrap';
+    }
+    if (options.eject) {
+        return 'eject';
+    }
+    return (0, prompts_1.askSwizzleAction)(componentConfig);
+}
+exports.getAction = getAction;
+async function isDir(dirPath) {
+    return ((await fs_extra_1.default.pathExists(dirPath)) && (await fs_extra_1.default.stat(dirPath)).isDirectory());
+}
+async function eject({ siteDir, themePath, componentName, }) {
+    const fromPath = path_1.default.join(themePath, componentName);
+    const isDirectory = await isDir(fromPath);
+    const globPattern = isDirectory
+        ? // do we really want to copy all components?
+            path_1.default.join(fromPath, '*')
+        : `${fromPath}.*`;
+    const globPatternPosix = (0, utils_1.posixPath)(globPattern);
+    const filesToCopy = await (0, utils_1.Globby)(globPatternPosix, {
+        ignore: ['**/*.{story,stories,test,tests}.{js,jsx,ts,tsx}'],
+    });
+    if (filesToCopy.length === 0) {
+        // This should never happen
+        throw new Error(logger_1.default.interpolate `No files to copy from path=${fromPath} with glob code=${globPatternPosix}`);
+    }
+    const toPath = isDirectory
+        ? path_1.default.join(siteDir, utils_1.THEME_PATH, componentName)
+        : path_1.default.join(siteDir, utils_1.THEME_PATH);
+    await fs_extra_1.default.ensureDir(toPath);
+    const createdFiles = await Promise.all(filesToCopy.map(async (sourceFile) => {
+        const fileName = path_1.default.basename(sourceFile);
+        const targetFile = path_1.default.join(toPath, fileName);
+        try {
+            await fs_extra_1.default.copy(sourceFile, targetFile, { overwrite: true });
+        }
+        catch (err) {
+            throw new Error(logger_1.default.interpolate `Could not copy file from ${sourceFile} to ${targetFile}`);
+        }
+        return targetFile;
+    }));
+    return { createdFiles };
+}
+exports.eject = eject;
+async function wrap({ siteDir, themePath, componentName: themeComponentName, typescript, importType = 'original', }) {
+    const isDirectory = await isDir(path_1.default.join(themePath, themeComponentName));
+    // Top/Parent/ComponentName => ComponentName
+    const componentName = lodash_1.default.last(themeComponentName.split('/'));
+    const wrapperComponentName = `${componentName}Wrapper`;
+    const wrapperFileName = `${themeComponentName}${isDirectory ? '/index' : ''}${typescript ? '.tsx' : '.js'}`;
+    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 type ${componentName}Type from '@theme/${themeComponentName}';
+import ${componentName} from '@theme-${importType}/${themeComponentName}';
+
+type Props = ComponentProps<typeof ${componentName}Type>
+
+export default function ${wrapperComponentName}(props: Props): JSX.Element {
+  return (
+    <>
+      <${componentName} {...props} />
+    </>
+  );
+}
+`
+        : `import React from 'react';
+import ${componentName} from '@theme-${importType}/${themeComponentName}';
+
+export default function ${wrapperComponentName}(props) {
+  return (
+    <>
+      <${componentName} {...props} />
+    </>
+  );
+}
+`;
+    await fs_extra_1.default.ensureDir(path_1.default.dirname(toPath));
+    await fs_extra_1.default.writeFile(toPath, content);
+    return { createdFiles: [toPath] };
+}
+exports.wrap = wrap;

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

@@ -0,0 +1,33 @@
+/**
+ * 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 { InitializedPlugin, SwizzleAction, SwizzleActionStatus } from '@docusaurus/types';
+import type { NormalizedPluginConfig } from '../../server/plugins/init';
+export declare const SwizzleActions: SwizzleAction[];
+export declare const SwizzleActionsStatuses: SwizzleActionStatus[];
+export declare const PartiallySafeHint: string;
+export declare function actionStatusLabel(status: SwizzleActionStatus): string;
+export declare function actionStatusColor(status: SwizzleActionStatus, str: string): string;
+export declare function actionStatusSuffix(status: SwizzleActionStatus, options?: {
+    partiallySafe?: boolean;
+}): string;
+export declare type SwizzlePlugin = {
+    instance: InitializedPlugin;
+    plugin: NormalizedPluginConfig;
+};
+export declare type SwizzleContext = {
+    plugins: SwizzlePlugin[];
+};
+export declare type SwizzleOptions = {
+    typescript: boolean;
+    danger: boolean;
+    list: boolean;
+    wrap: boolean;
+    eject: boolean;
+};
+export declare function normalizeOptions(options: Partial<SwizzleOptions>): SwizzleOptions;
+export declare function findStringIgnoringCase(str: string, values: string[]): string | undefined;
+export declare function findClosestValue(str: string, values: string[], maxLevenshtein?: number): string | undefined;

package/lib/commands/swizzle/common.js

@@ -0,0 +1,57 @@
+"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.findClosestValue = exports.findStringIgnoringCase = exports.normalizeOptions = exports.actionStatusSuffix = exports.actionStatusColor = exports.actionStatusLabel = exports.PartiallySafeHint = exports.SwizzleActionsStatuses = exports.SwizzleActions = void 0;
+const tslib_1 = require("tslib");
+const leven_1 = (0, tslib_1.__importDefault)(require("leven"));
+const lodash_1 = (0, tslib_1.__importDefault)(require("lodash"));
+const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
+exports.SwizzleActions = ['wrap', 'eject'];
+exports.SwizzleActionsStatuses = [
+    'safe',
+    'unsafe',
+    'forbidden',
+];
+exports.PartiallySafeHint = logger_1.default.red('*');
+function actionStatusLabel(status) {
+    return lodash_1.default.capitalize(status);
+}
+exports.actionStatusLabel = actionStatusLabel;
+const SwizzleActionStatusColors = {
+    safe: logger_1.default.green,
+    unsafe: logger_1.default.yellow,
+    forbidden: logger_1.default.red,
+};
+function actionStatusColor(status, str) {
+    const colorFn = SwizzleActionStatusColors[status];
+    return colorFn(str);
+}
+exports.actionStatusColor = actionStatusColor;
+function actionStatusSuffix(status, options = {}) {
+    return ` (${actionStatusColor(status, actionStatusLabel(status))}${options.partiallySafe ? exports.PartiallySafeHint : ''})`;
+}
+exports.actionStatusSuffix = actionStatusSuffix;
+function normalizeOptions(options) {
+    var _a, _b, _c, _d, _e;
+    return {
+        typescript: (_a = options.typescript) !== null && _a !== void 0 ? _a : false,
+        danger: (_b = options.danger) !== null && _b !== void 0 ? _b : false,
+        list: (_c = options.list) !== null && _c !== void 0 ? _c : false,
+        wrap: (_d = options.wrap) !== null && _d !== void 0 ? _d : false,
+        eject: (_e = options.eject) !== null && _e !== void 0 ? _e : false,
+    };
+}
+exports.normalizeOptions = normalizeOptions;
+function findStringIgnoringCase(str, values) {
+    return values.find((v) => v.toLowerCase() === str.toLowerCase());
+}
+exports.findStringIgnoringCase = findStringIgnoringCase;
+function findClosestValue(str, values, maxLevenshtein = 3) {
+    return values.find((v) => (0, leven_1.default)(v, str) <= maxLevenshtein);
+}
+exports.findClosestValue = findClosestValue;

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

@@ -0,0 +1,29 @@
+/**
+ * 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 { SwizzleAction, SwizzleActionStatus, SwizzleComponentConfig, SwizzleConfig } from '@docusaurus/types';
+export declare type ThemeComponents = {
+    themeName: string;
+    all: string[];
+    getConfig: (component: string) => SwizzleComponentConfig;
+    getDescription: (component: string) => string;
+    getActionStatus: (component: string, action: SwizzleAction) => SwizzleActionStatus;
+    isSafeAction: (component: string, action: SwizzleAction) => boolean;
+    hasAnySafeAction: (component: string) => boolean;
+    hasAllSafeAction: (component: string) => boolean;
+};
+export declare function readComponentNames(themePath: string): Promise<string[]>;
+export declare function listComponentNames(themeComponents: ThemeComponents): string;
+export declare function getThemeComponents({ themeName, themePath, swizzleConfig, }: {
+    themeName: string;
+    themePath: string;
+    swizzleConfig: SwizzleConfig;
+}): Promise<ThemeComponents>;
+export declare function getComponentName({ componentNameParam, themeComponents, list, }: {
+    componentNameParam: string | undefined;
+    themeComponents: ThemeComponents;
+    list: boolean | undefined;
+}): Promise<string>;

package/lib/commands/swizzle/components.js

@@ -0,0 +1,165 @@
+"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.getComponentName = exports.getThemeComponents = exports.listComponentNames = exports.readComponentNames = void 0;
+const tslib_1 = require("tslib");
+const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
+const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
+const path_1 = (0, tslib_1.__importDefault)(require("path"));
+const lodash_1 = (0, tslib_1.__importDefault)(require("lodash"));
+const utils_1 = require("@docusaurus/utils");
+const prompts_1 = require("./prompts");
+const common_1 = require("./common");
+const tables_1 = require("./tables");
+const actions_1 = require("./actions");
+const formatComponentName = (componentName) => componentName.replace(/[/\\]index\.[jt]sx?/, '').replace(/\.[jt]sx?/, '');
+const skipReadDirNames = ['__test__', '__tests__', '__mocks__', '__fixtures__'];
+async function readComponentNames(themePath) {
+    if (!(await fs_extra_1.default.pathExists(themePath))) {
+        return [];
+    }
+    async function walk(dir) {
+        const files = await Promise.all((await fs_extra_1.default.readdir(dir)).flatMap(async (file) => {
+            const fullPath = path_1.default.join(dir, file);
+            const stat = await fs_extra_1.default.stat(fullPath);
+            const isDir = stat.isDirectory();
+            return { file, fullPath, isDir };
+        }));
+        return (await Promise.all(files.map(async (file) => {
+            if (file.isDir) {
+                if (skipReadDirNames.includes(file.file)) {
+                    return [];
+                }
+                return walk(file.fullPath);
+            }
+            else if (
+            // TODO can probably be refactored
+            /(?<!\.d)\.[jt]sx?$/.test(file.fullPath) &&
+                !/(?<!\.d)\.(?:test|tests|story|stories)\.[jt]sx?$/.test(file.fullPath)) {
+                const componentName = formatComponentName((0, utils_1.posixPath)(path_1.default.relative(themePath, file.fullPath)));
+                return [{ ...file, componentName }];
+            }
+            return [];
+        }))).flat();
+    }
+    const componentFiles = await walk(themePath);
+    const componentFilesOrdered = lodash_1.default.orderBy(componentFiles, [(f) => f.componentName], ['asc']);
+    return componentFilesOrdered.map((f) => f.componentName);
+}
+exports.readComponentNames = readComponentNames;
+function listComponentNames(themeComponents) {
+    if (themeComponents.all.length === 0) {
+        return 'No component to swizzle.';
+    }
+    return `${(0, tables_1.themeComponentsTable)(themeComponents)}
+
+${(0, tables_1.helpTables)()}
+`;
+}
+exports.listComponentNames = listComponentNames;
+async function getThemeComponents({ themeName, themePath, swizzleConfig, }) {
+    const FallbackSwizzleActionStatus = 'unsafe';
+    const FallbackSwizzleComponentDescription = 'N/A';
+    const FallbackSwizzleComponentConfig = {
+        actions: {
+            wrap: FallbackSwizzleActionStatus,
+            eject: FallbackSwizzleActionStatus,
+        },
+        description: FallbackSwizzleComponentDescription,
+    };
+    const allComponents = await readComponentNames(themePath);
+    function getConfig(component) {
+        var _a;
+        if (!allComponents.includes(component)) {
+            throw new Error(`Can't get component config: component doesn't exist: ${component}`);
+        }
+        return ((_a = swizzleConfig.components[component]) !== null && _a !== void 0 ? _a : FallbackSwizzleComponentConfig);
+    }
+    function getDescription(component) {
+        var _a;
+        return ((_a = getConfig(component).description) !== null && _a !== void 0 ? _a : FallbackSwizzleComponentDescription);
+    }
+    function getActionStatus(component, action) {
+        var _a;
+        return (_a = getConfig(component).actions[action]) !== null && _a !== void 0 ? _a : FallbackSwizzleActionStatus;
+    }
+    function isSafeAction(component, action) {
+        return getActionStatus(component, action) === 'safe';
+    }
+    function hasAllSafeAction(component) {
+        return actions_1.SwizzleActions.every((action) => isSafeAction(component, action));
+    }
+    function hasAnySafeAction(component) {
+        return actions_1.SwizzleActions.some((action) => isSafeAction(component, action));
+    }
+    // Present the safest components first
+    const orderedComponents = lodash_1.default.orderBy(allComponents, [
+        hasAllSafeAction,
+        (component) => isSafeAction(component, 'wrap'),
+        (component) => isSafeAction(component, 'eject'),
+        (component) => component,
+    ], ['desc', 'desc', 'desc', 'asc']);
+    return {
+        themeName,
+        all: orderedComponents,
+        getConfig,
+        getDescription,
+        getActionStatus,
+        isSafeAction,
+        hasAnySafeAction,
+        hasAllSafeAction,
+    };
+}
+exports.getThemeComponents = getThemeComponents;
+// Returns a valid value if recovering is possible
+function handleInvalidComponentNameParam({ componentNameParam, themeComponents, }) {
+    // Trying to recover invalid value
+    // We look for potential matches that only differ in casing.
+    const differentCaseMatch = (0, common_1.findStringIgnoringCase)(componentNameParam, themeComponents.all);
+    if (differentCaseMatch) {
+        logger_1.default.warn `Component name=${componentNameParam} doesn't exist.`;
+        logger_1.default.info `name=${differentCaseMatch} will be used instead of name=${componentNameParam}.`;
+        return differentCaseMatch;
+    }
+    // No recovery value is possible: print error
+    logger_1.default.error `Component name=${componentNameParam} not found.`;
+    const suggestion = (0, common_1.findClosestValue)(componentNameParam, themeComponents.all);
+    if (suggestion) {
+        logger_1.default.info `Did you mean name=${suggestion}? ${themeComponents.hasAnySafeAction(suggestion)
+            ? `Note: this component is an unsafe internal component and can only be swizzled with code=${'--danger'} or explicit confirmation.`
+            : ''}`;
+    }
+    else {
+        logger_1.default.info(listComponentNames(themeComponents));
+    }
+    return process.exit(1);
+}
+async function handleComponentNameParam({ componentNameParam, themeComponents, }) {
+    const isValidName = themeComponents.all.includes(componentNameParam);
+    if (!isValidName) {
+        return handleInvalidComponentNameParam({
+            componentNameParam,
+            themeComponents,
+        });
+    }
+    return componentNameParam;
+}
+async function getComponentName({ componentNameParam, themeComponents, list, }) {
+    if (list) {
+        logger_1.default.info(listComponentNames(themeComponents));
+        return process.exit(0);
+    }
+    const componentName = componentNameParam
+        ? await handleComponentNameParam({
+            componentNameParam,
+            themeComponents,
+        })
+        : await (0, prompts_1.askComponentName)(themeComponents);
+    return componentName;
+}
+exports.getComponentName = getComponentName;

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

@@ -0,0 +1,10 @@
+/**
+ * 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 { SwizzleConfig } from '@docusaurus/types';
+import type { SwizzlePlugin } from './common';
+export declare function normalizeSwizzleConfig(unsafeSwizzleConfig: unknown): SwizzleConfig;
+export declare function getThemeSwizzleConfig(themeName: string, plugins: SwizzlePlugin[]): SwizzleConfig;