@docusaurus/core 0.0.0-4630 → 0.0.0-4633

package/lib/server/plugins/init.js

@@ -6,6 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizePluginConfigs = void 0;
 const tslib_1 = require("tslib");
 const module_1 = require("module");
 const import_fresh_1 = (0, tslib_1.__importDefault)(require("import-fresh"));
@@ -65,6 +66,10 @@ async function normalizePluginConfig(pluginConfig, pluginRequire) {
     }
     throw new Error(`Unexpected: can't load plugin for following plugin config.\n${JSON.stringify(pluginConfig)}`);
 }
+async function normalizePluginConfigs(pluginConfigs, pluginRequire) {
+    return Promise.all(pluginConfigs.map((pluginConfig) => normalizePluginConfig(pluginConfig, pluginRequire)));
+}
+exports.normalizePluginConfigs = normalizePluginConfigs;
 function getOptionValidationFunction(normalizedPluginConfig) {
     var _a, _b, _c, _d;
     if (normalizedPluginConfig.pluginModule) {
@@ -85,6 +90,7 @@ async function initPlugins({ pluginConfigs, context, }) {
     // We need to resolve plugins from the perspective of the siteDir, since the
     // siteDir's package.json declares the dependency on these plugins.
     const pluginRequire = (0, module_1.createRequire)(context.siteConfigPath);
+    const pluginConfigsNormalized = await normalizePluginConfigs(pluginConfigs, pluginRequire);
     async function doGetPluginVersion(normalizedPluginConfig) {
         var _a, _b;
         // get plugin version
@@ -120,8 +126,7 @@ async function initPlugins({ pluginConfigs, context, }) {
             id: (_a = normalizedPluginConfig.options.id) !== null && _a !== void 0 ? _a : utils_1.DEFAULT_PLUGIN_ID,
         };
     }
-    async function initializePlugin(pluginConfig) {
-        const normalizedPluginConfig = await normalizePluginConfig(pluginConfig, pluginRequire);
+    async function initializePlugin(normalizedPluginConfig) {
         const pluginVersion = await doGetPluginVersion(normalizedPluginConfig);
         const pluginOptions = doValidatePluginOptions(normalizedPluginConfig);
         // Side-effect: merge the normalized theme config in the original one
@@ -136,7 +141,7 @@ async function initPlugins({ pluginConfigs, context, }) {
             version: pluginVersion,
         };
     }
-    const plugins = (await Promise.all(pluginConfigs.map((pluginConfig) => {
+    const plugins = (await Promise.all(pluginConfigsNormalized.map((pluginConfig) => {
         if (!pluginConfig) {
             return null;
         }

package/lib/server/translations/translations.js

@@ -35,8 +35,9 @@ async function readTranslationFileContent(filePath) {
             ensureTranslationFileContent(content);
             return content;
         }
-        catch (e) {
-            throw new Error(`Invalid translation file at ${filePath}.\n${e.message}`);
+        catch (err) {
+            logger_1.default.error `Invalid translation file at path=${filePath}.`;
+            throw err;
         }
     }
     return undefined;

package/lib/server/translations/translationsExtractor.js

@@ -103,11 +103,9 @@ async function extractSourceCodeFileTranslations(sourceCodeFilePath, babelOption
         const translations = await extractSourceCodeAstTranslations(ast, sourceCodeFilePath);
         return translations;
     }
-    catch (e) {
-        if (e instanceof Error) {
-            e.message = `Error while attempting to extract Docusaurus translations from source code file at path=${sourceCodeFilePath}\n${e.message}`;
-        }
-        throw e;
+    catch (err) {
+        logger_1.default.error `Error while attempting to extract Docusaurus translations from source code file at path=${sourceCodeFilePath}.`;
+        throw err;
     }
 }
 exports.extractSourceCodeFileTranslations = extractSourceCodeFileTranslations;

package/lib/server/versions/index.d.ts

@@ -6,5 +6,4 @@
  */
 import type { DocusaurusPluginVersionInformation } from '@docusaurus/types';
 export declare function getPackageJsonVersion(packageJsonPath: string): Promise<string | undefined>;
-export declare function getPackageJsonName(packageJsonPath: string): Promise<string | undefined>;
 export declare function getPluginVersion(pluginPath: string, siteDir: string): Promise<DocusaurusPluginVersionInformation>;

package/lib/server/versions/index.js

@@ -6,15 +6,14 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPluginVersion = exports.getPackageJsonName = exports.getPackageJsonVersion = void 0;
+exports.getPluginVersion = exports.getPackageJsonVersion = void 0;
 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"));
 async function getPackageJsonVersion(packageJsonPath) {
     if (await fs_extra_1.default.pathExists(packageJsonPath)) {
         // eslint-disable-next-line @typescript-eslint/no-var-requires, import/no-dynamic-require, global-require
-        const { version } = require(packageJsonPath);
-        return typeof version === 'string' ? version : undefined;
+        return require(packageJsonPath).version;
     }
     return undefined;
 }
@@ -22,12 +21,10 @@ exports.getPackageJsonVersion = getPackageJsonVersion;
 async function getPackageJsonName(packageJsonPath) {
     if (await fs_extra_1.default.pathExists(packageJsonPath)) {
         // eslint-disable-next-line @typescript-eslint/no-var-requires, import/no-dynamic-require, global-require
-        const { name } = require(packageJsonPath);
-        return typeof name === 'string' ? name : undefined;
+        return require(packageJsonPath).name;
     }
     return undefined;
 }
-exports.getPackageJsonName = getPackageJsonName;
 async function getPluginVersion(pluginPath, siteDir) {
     let potentialPluginPackageJsonDirectory = path_1.default.dirname(pluginPath);
     while (potentialPluginPackageJsonDirectory !== '/') {

package/lib/webpack/plugins/CleanWebpackPlugin.js

@@ -134,13 +134,13 @@ class CleanWebpackPlugin {
                 });
             }
         }
-        catch (error) {
-            const needsForce = /Cannot delete files\/folders outside the current working directory\./.test(error.message);
+        catch (err) {
+            const needsForce = /Cannot delete files\/folders outside the current working directory\./.test(err.message);
             if (needsForce) {
                 const message = 'clean-webpack-plugin: Cannot delete files/folders outside the current working directory. Can be overridden with the "dangerouslyAllowCleanPatternsOutsideProject" option.';
                 throw new Error(message);
             }
-            throw error;
+            throw err;
         }
     }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "0.0.0-4630",
+  "version": "0.0.0-4633",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -41,13 +41,13 @@
     "@babel/runtime": "^7.17.2",
     "@babel/runtime-corejs3": "^7.17.2",
     "@babel/traverse": "^7.17.3",
-    "@docusaurus/cssnano-preset": "0.0.0-4630",
-    "@docusaurus/logger": "0.0.0-4630",
-    "@docusaurus/mdx-loader": "0.0.0-4630",
+    "@docusaurus/cssnano-preset": "0.0.0-4633",
+    "@docusaurus/logger": "0.0.0-4633",
+    "@docusaurus/mdx-loader": "0.0.0-4633",
     "@docusaurus/react-loadable": "5.5.2",
-    "@docusaurus/utils": "0.0.0-4630",
-    "@docusaurus/utils-common": "0.0.0-4630",
-    "@docusaurus/utils-validation": "0.0.0-4630",
+    "@docusaurus/utils": "0.0.0-4633",
+    "@docusaurus/utils-common": "0.0.0-4633",
+    "@docusaurus/utils-validation": "0.0.0-4633",
     "@slorber/static-site-generator-webpack-plugin": "^4.0.1",
     "@svgr/webpack": "^6.2.1",
     "autoprefixer": "^10.4.2",
@@ -56,6 +56,7 @@
     "boxen": "^6.2.1",
     "chokidar": "^3.5.3",
     "clean-css": "^5.2.4",
+    "cli-table3": "^0.6.1",
     "combine-promises": "^1.1.0",
     "commander": "^5.1.0",
     "copy-webpack-plugin": "^10.2.4",
@@ -105,8 +106,8 @@
     "webpackbar": "^5.0.2"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4630",
-    "@docusaurus/types": "0.0.0-4630",
+    "@docusaurus/module-type-aliases": "0.0.0-4633",
+    "@docusaurus/types": "0.0.0-4633",
     "@types/detect-port": "^1.3.2",
     "@types/nprogress": "^0.2.0",
     "@types/react-dom": "^17.0.11",
@@ -117,7 +118,8 @@
     "@types/wait-on": "^5.3.1",
     "@types/webpack-bundle-analyzer": "^4.4.1",
     "react-test-renderer": "^17.0.2",
-    "tmp-promise": "^3.0.3"
+    "tmp-promise": "^3.0.3",
+    "tree-node-cli": "^1.5.2"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
@@ -126,5 +128,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "aadefa165fdcbb364fd83ca33a18b987b94c28b0"
+  "gitHead": "565aa1336079094585ee040af351f87a51df711b"
 }

package/lib/commands/swizzle.d.ts

@@ -1,9 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-import type { 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

@@ -1,239 +0,0 @@
-"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.getPluginNames = void 0;
-const tslib_1 = require("tslib");
-/* eslint-disable no-restricted-properties */
-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"));
-const leven_1 = (0, tslib_1.__importDefault)(require("leven"));
-const lodash_1 = require("lodash");
-const utils_1 = require("@docusaurus/utils");
-const server_1 = require("../server");
-const init_1 = (0, tslib_1.__importDefault)(require("../server/plugins/init"));
-const utils_validation_1 = require("@docusaurus/utils-validation");
-function getPluginNames(plugins) {
-    return plugins
-        .filter((plugin) => typeof plugin === 'string' ||
-        (Array.isArray(plugin) && typeof plugin[0] === 'string'))
-        .map((plugin) => {
-        const pluginPath = Array.isArray(plugin) ? plugin[0] : plugin;
-        if (typeof pluginPath === 'string') {
-            let packagePath = path_1.default.dirname(pluginPath);
-            while (packagePath) {
-                if (fs_extra_1.default.existsSync(path_1.default.join(packagePath, 'package.json'))) {
-                    break;
-                }
-                else {
-                    packagePath = path_1.default.dirname(packagePath);
-                }
-            }
-            if (packagePath === '.') {
-                return pluginPath;
-            }
-            return (0, import_fresh_1.default)(path_1.default.join(packagePath, 'package.json')).name;
-        }
-        return '';
-    })
-        .filter((plugin) => plugin !== '');
-}
-exports.getPluginNames = getPluginNames;
-const formatComponentName = (componentName) => componentName
-    .replace(/[\\/]index\.(?:jsx?|tsx?)/, '')
-    .replace(/\.(?:jsx?|tsx?)/, '');
-function readComponent(themePath) {
-    function walk(dir) {
-        let results = [];
-        const list = fs_extra_1.default.readdirSync(dir);
-        list.forEach((file) => {
-            const fullPath = path_1.default.join(dir, file);
-            const stat = fs_extra_1.default.statSync(fullPath);
-            if (stat && stat.isDirectory()) {
-                results = results.concat(walk(fullPath));
-            }
-            else if (!/\.css|\.d\.ts|\.d\.map/.test(fullPath)) {
-                results.push(fullPath);
-            }
-        });
-        return results;
-    }
-    return walk(themePath).map((filePath) => formatComponentName(path_1.default.relative(themePath, filePath)));
-}
-// load components from theme based on configurations
-function getComponentName(themePath, plugin, danger) {
-    var _a, _b;
-    // support both commonjs and ES style exports
-    const getSwizzleComponentList = (_b = (_a = plugin.default) === null || _a === void 0 ? void 0 : _a.getSwizzleComponentList) !== null && _b !== void 0 ? _b : plugin.getSwizzleComponentList;
-    if (getSwizzleComponentList) {
-        const allowedComponent = getSwizzleComponentList();
-        if (danger) {
-            return readComponent(themePath);
-        }
-        return allowedComponent;
-    }
-    return readComponent(themePath);
-}
-function themeComponents(themePath, plugin) {
-    const components = colorCode(themePath, plugin);
-    if (components.length === 0) {
-        return 'No component to swizzle.';
-    }
-    return `Theme components available for swizzle.
-
-${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 colorCode(themePath, plugin) {
-    var _a, _b;
-    // support both commonjs and ES style exports
-    const getSwizzleComponentList = (_b = (_a = plugin.default) === null || _a === void 0 ? void 0 : _a.getSwizzleComponentList) !== null && _b !== void 0 ? _b : plugin.getSwizzleComponentList;
-    const components = readComponent(themePath);
-    const allowedComponent = getSwizzleComponentList
-        ? getSwizzleComponentList()
-        : [];
-    const [greenComponents, redComponents] = (0, lodash_1.partition)(components, (comp) => allowedComponent.includes(comp));
-    return [
-        ...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) {
-    var _a, _b, _c, _d, _e;
-    const context = await (0, server_1.loadContext)(siteDir);
-    const pluginConfigs = await (0, server_1.loadPluginConfigs)(context);
-    const pluginNames = getPluginNames(pluginConfigs);
-    const plugins = await (0, init_1.default)({
-        pluginConfigs,
-        context,
-    });
-    const themeNames = pluginNames.filter((_, index) => typescript
-        ? plugins[index].getTypeScriptThemePath
-        : plugins[index].getThemePath);
-    if (!themeName) {
-        logger_1.default.info `Themes available for swizzle: name=${themeNames}`;
-        return;
-    }
-    let pluginModule;
-    try {
-        pluginModule = (0, import_fresh_1.default)(themeName);
-    }
-    catch {
-        let suggestion;
-        themeNames.forEach((name) => {
-            if ((0, leven_1.default)(name, themeName) < 4) {
-                suggestion = name;
-            }
-        });
-        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 = {};
-    const resolvedThemeName = require.resolve(themeName);
-    // find the plugin from list of plugin and get options if specified
-    pluginConfigs.forEach((pluginConfig) => {
-        // plugin can be a [string], [string,object] or string.
-        if (Array.isArray(pluginConfig) && typeof pluginConfig[0] === 'string') {
-            if (require.resolve(pluginConfig[0]) === resolvedThemeName) {
-                if (pluginConfig.length === 2) {
-                    const [, options] = pluginConfig;
-                    pluginOptions = options;
-                }
-            }
-        }
-    });
-    // support both commonjs and ES style exports
-    const validateOptions = (_b = (_a = pluginModule.default) === null || _a === void 0 ? void 0 : _a.validateOptions) !== null && _b !== void 0 ? _b : pluginModule.validateOptions;
-    if (validateOptions) {
-        pluginOptions = validateOptions({
-            validate: utils_validation_1.normalizePluginOptions,
-            options: pluginOptions,
-        });
-    }
-    // support both commonjs and ES style exports
-    const plugin = (_c = pluginModule.default) !== null && _c !== void 0 ? _c : pluginModule;
-    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) {
-        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) {
-        logger_1.default.info(themeComponents(themePath, pluginModule));
-        return;
-    }
-    const components = getComponentName(themePath, pluginModule, Boolean(danger));
-    const formattedComponentName = formatComponentName(componentName);
-    const isComponentExists = components.find((component) => component === formattedComponentName);
-    let mostSuitableComponent = componentName;
-    if (!isComponentExists) {
-        let mostSuitableMatch = componentName;
-        let score = formattedComponentName.length;
-        components.forEach((component) => {
-            if (component.toLowerCase() === formattedComponentName.toLowerCase()) {
-                // may be components with same lowercase key, try to match closest
-                // component
-                const currentScore = (0, leven_1.default)(formattedComponentName, component);
-                if (currentScore < score) {
-                    score = currentScore;
-                    mostSuitableMatch = component;
-                }
-            }
-        });
-        if (mostSuitableMatch !== componentName) {
-            mostSuitableComponent = mostSuitableMatch;
-            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);
-    let toPath = path_1.default.resolve(siteDir, utils_1.THEME_PATH, mostSuitableComponent);
-    // Handle single TypeScript/JavaScript file only.
-    // E.g: if <fromPath> does not exist, we try to swizzle
-    // <fromPath>.(ts|tsx|js) instead
-    if (!fs_extra_1.default.existsSync(fromPath)) {
-        if (fs_extra_1.default.existsSync(`${fromPath}.ts`)) {
-            [fromPath, toPath] = [`${fromPath}.ts`, `${toPath}.ts`];
-        }
-        else if (fs_extra_1.default.existsSync(`${fromPath}.tsx`)) {
-            [fromPath, toPath] = [`${fromPath}.tsx`, `${toPath}.tsx`];
-        }
-        else if (fs_extra_1.default.existsSync(`${fromPath}.js`)) {
-            [fromPath, toPath] = [`${fromPath}.js`, `${toPath}.js`];
-        }
-        else {
-            let suggestion;
-            components.forEach((name) => {
-                if ((0, leven_1.default)(name, mostSuitableComponent) < 3) {
-                    suggestion = name;
-                }
-            });
-            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) {
-        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);
-    logger_1.default.success `Copied code=${mostSuitableComponent ? `${themeName} ${mostSuitableComponent}` : themeName} to path=${path_1.default.relative(process.cwd(), toPath)}.`;
-}
-exports.default = swizzle;