@docusaurus/core 2.0.0-beta.15a2b59f9 → 2.0.0-beta.17

package/lib/commands/swizzle.js

@@ -1,245 +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");
-const chalk = require("chalk");
-const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
-const import_fresh_1 = tslib_1.__importDefault(require("import-fresh"));
-const path_1 = tslib_1.__importDefault(require("path"));
-const leven_1 = tslib_1.__importDefault(require("leven"));
-const lodash_1 = require("lodash");
-const constants_1 = require("../constants");
-const server_1 = require("../server");
-const init_1 = 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 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.(js|tsx|ts|jsx)/, '')
-    .replace(/.(js|tsx|ts|jsx)/, '');
-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 `${chalk.red('No component to swizzle.')}`;
-    }
-    return `
-${chalk.cyan('Theme components available for swizzle.')}
-
-${chalk.green('green  =>')} safe: lower breaking change risk
-${chalk.red('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
-    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] = lodash_1.partition(components, (comp) => allowedComponent.includes(comp));
-    return [
-        ...greenComponents.map((component) => chalk.green(`safe: ${component}`)),
-        ...redComponents.map((component) => chalk.red(`unsafe: ${component}`)),
-    ];
-}
-async function swizzle(siteDir, themeName, componentName, typescript, danger) {
-    var _a, _b, _c, _d, _e;
-    const context = await server_1.loadContext(siteDir);
-    const pluginConfigs = server_1.loadPluginConfigs(context);
-    const pluginNames = getPluginNames(pluginConfigs);
-    const plugins = init_1.default({
-        pluginConfigs,
-        context,
-    });
-    const themeNames = pluginNames.filter((_, index) => typescript
-        ? plugins[index].getTypeScriptThemePath
-        : plugins[index].getThemePath);
-    if (!themeName) {
-        console.log(formattedThemeNames(themeNames));
-        process.exit(1);
-    }
-    let pluginModule;
-    try {
-        pluginModule = import_fresh_1.default(themeName);
-    }
-    catch {
-        let suggestion;
-        themeNames.forEach((name) => {
-            if (leven_1.default(name, themeName) < 4) {
-                suggestion = name;
-            }
-        });
-        chalk.red(`Theme ${themeName} not found. ${suggestion
-            ? `Did you mean "${suggestion}" ?`
-            : formattedThemeNames(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 = 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.yellow(typescript
-            ? `${themeName} does not provide TypeScript theme code via "getTypeScriptThemePath()".`
-            : `${themeName} does not provide any theme code.`));
-        process.exit(1);
-    }
-    if (!componentName) {
-        console.warn(themeComponents(themePath, pluginModule));
-        process.exit(1);
-    }
-    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 = leven_1.default(formattedComponentName, component);
-                if (currentScore < score) {
-                    score = currentScore;
-                    mostSuitableMatch = component;
-                }
-            }
-        });
-        if (mostSuitableMatch !== componentName) {
-            mostSuitableComponent = mostSuitableMatch;
-            console.log(chalk.red(`Component "${componentName}" doesn't exist.`), chalk.yellow(`"${mostSuitableComponent}" is swizzled instead of "${componentName}".`));
-        }
-    }
-    let fromPath = path_1.default.join(themePath, mostSuitableComponent);
-    let toPath = path_1.default.resolve(siteDir, constants_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 (leven_1.default(name, mostSuitableComponent) < 3) {
-                    suggestion = name;
-                }
-            });
-            console.warn(chalk.red(`Component ${mostSuitableComponent} not found.`));
-            console.warn(suggestion
-                ? `Did you mean "${suggestion}"?`
-                : `${themeComponents(themePath, pluginModule)}`);
-            process.exit(1);
-        }
-    }
-    if (!components.includes(mostSuitableComponent) && !danger) {
-        console.warn(chalk.red(`${mostSuitableComponent} is an internal component and has a higher breaking change probability. If you want to swizzle it, use the "--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.blue(mostSuitableComponent
-        ? `${themeName} ${chalk.yellow(mostSuitableComponent)}`
-        : themeName);
-    const toMsg = chalk.cyan(relativeDir);
-    console.log(`\n${chalk.green('Success!')} Copied ${fromMsg} to ${toMsg}.\n`);
-}
-exports.default = swizzle;

package/lib/constants.d.ts

@@ -1,18 +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.
- */
-export declare const NODE_MAJOR_VERSION: number;
-export declare const NODE_MINOR_VERSION: number;
-export declare const DEFAULT_BUILD_DIR_NAME = "build";
-export declare const DEFAULT_CONFIG_FILE_NAME = "docusaurus.config.js";
-export declare const BABEL_CONFIG_FILE_NAME: string;
-export declare const GENERATED_FILES_DIR_NAME: string;
-export declare const SRC_DIR_NAME = "src";
-export declare const STATIC_DIR_NAME = "static";
-export declare const OUTPUT_STATIC_ASSETS_DIR_NAME = "assets";
-export declare const THEME_PATH: string;
-export declare const DEFAULT_PORT = 3000;
-export declare const DEFAULT_PLUGIN_ID = "default";

package/lib/constants.js

@@ -1,23 +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.DEFAULT_PLUGIN_ID = exports.DEFAULT_PORT = exports.THEME_PATH = exports.OUTPUT_STATIC_ASSETS_DIR_NAME = exports.STATIC_DIR_NAME = exports.SRC_DIR_NAME = exports.GENERATED_FILES_DIR_NAME = exports.BABEL_CONFIG_FILE_NAME = exports.DEFAULT_CONFIG_FILE_NAME = exports.DEFAULT_BUILD_DIR_NAME = exports.NODE_MINOR_VERSION = exports.NODE_MAJOR_VERSION = void 0;
-exports.NODE_MAJOR_VERSION = parseInt(process.versions.node.split('.')[0], 10);
-exports.NODE_MINOR_VERSION = parseInt(process.versions.node.split('.')[1], 10);
-// Can be overridden with cli option --out-dir
-exports.DEFAULT_BUILD_DIR_NAME = 'build';
-// Can be overridden with cli option --config
-exports.DEFAULT_CONFIG_FILE_NAME = 'docusaurus.config.js';
-exports.BABEL_CONFIG_FILE_NAME = process.env.DOCUSAURUS_BABEL_CONFIG_FILE_NAME || 'babel.config.js';
-exports.GENERATED_FILES_DIR_NAME = process.env.DOCUSAURUS_GENERATED_FILES_DIR_NAME || '.docusaurus';
-exports.SRC_DIR_NAME = 'src';
-exports.STATIC_DIR_NAME = 'static';
-exports.OUTPUT_STATIC_ASSETS_DIR_NAME = 'assets'; // files handled by webpack, hashed (can be cached aggressively)
-exports.THEME_PATH = `${exports.SRC_DIR_NAME}/theme`;
-exports.DEFAULT_PORT = 3000;
-exports.DEFAULT_PLUGIN_ID = 'default';

package/lib/server/loadSetup.js

@@ -1,25 +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 });
-const tslib_1 = require("tslib");
-const path_1 = tslib_1.__importDefault(require("path"));
-const index_1 = require("./index");
-// Helper methods to setup dummy/fake projects.
-const loadSetup = async (name) => {
-    const fixtures = path_1.default.join(__dirname, '__tests__', '__fixtures__');
-    const simpleSite = path_1.default.join(fixtures, 'simple-site');
-    const customSite = path_1.default.join(fixtures, 'custom-site');
-    switch (name) {
-        case 'custom':
-            return index_1.load(customSite);
-        case 'simple':
-        default:
-            return index_1.load(simpleSite);
-    }
-};
-exports.default = loadSetup;

package/lib/server/versions/__tests/index.test.js

@@ -1,25 +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 });
-const __1 = require("..");
-const path_1 = require("path");
-describe('getPluginVersion', () => {
-    it('Can detect external packages plugins versions of correctly.', () => {
-        expect(__1.getPluginVersion(path_1.join(__dirname, '..', '__fixtures__', 'dummy-plugin.js'), 
-        // Make the plugin appear external.
-        path_1.join(__dirname, '..', '..', '..', '..', '..', '..', 'website'))).toEqual({ type: 'package', version: 'random-version' });
-    });
-    it('Can detect project plugins versions correctly.', () => {
-        expect(__1.getPluginVersion(path_1.join(__dirname, '..', '__fixtures__', 'dummy-plugin.js'), 
-        // Make the plugin appear project local.
-        path_1.join(__dirname, '..', '__fixtures__'))).toEqual({ type: 'project' });
-    });
-    it('Can detect local packages versions correctly.', () => {
-        expect(__1.getPluginVersion('/', '/')).toEqual({ type: 'local' });
-    });
-});

package/lib/webpack/react-dev-utils-webpack5/README.md

@@ -1,11 +0,0 @@
-This is a temporary copy of
-
-CRA / react-dev-utils does not support Webpack 5 yet
-
-https://github.com/facebook/create-react-app/issues/9994
-
-This folder is a temporary copy of some react-dev-utils code to which we made some changes to support Webpack 5 without warnings
-
-TODO remove this folder once Webpack 5 is supported (https://github.com/facebook/create-react-app/issues/9994)
-
-The comment `// modified for Docusaurus` is added near the modified elements

package/lib/webpack/react-dev-utils-webpack5/evalSourceMapMiddleware.js

@@ -1,57 +0,0 @@
-/**
- * Copyright (c) 2015-present, Facebook, Inc.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-/* eslint-disable */
-/*
- * THIS FILE IS MODIFIED FOR DOCUSAURUS
- * the above copyright header must be preserved for license compliance.
- */
-
-/*
-Implementation based on comment: https://github.com/facebook/create-react-app/issues/9994#issuecomment-811289191
- */
-
-function base64SourceMap(source) {
-  const base64 = Buffer.from(JSON.stringify(source.map()), 'utf8').toString(
-    'base64',
-  );
-  return `data:application/json;charset=utf-8;base64,${base64}`;
-}
-
-// modified for Docusaurus => remove webpack 5 deprecation warnings
-// See https://github.com/facebook/create-react-app/issues/9994#issuecomment-811289191
-function getSourceById(server, id) {
-  const module = Array.from(server._stats.compilation.modules).find(
-    (m) => server._stats.compilation.chunkGraph.getModuleId(m) == id,
-  );
-  return module.originalSource();
-}
-
-/*
- * Middleware responsible for retrieving a generated source
- * Receives a webpack internal url: "webpack-internal:///<module-id>"
- * Returns a generated source: "<source-text><sourceMappingURL><sourceURL>"
- *
- * Based on EvalSourceMapDevToolModuleTemplatePlugin.js
- */
-module.exports = function createEvalSourceMapMiddleware(server) {
-  return function handleWebpackInternalMiddleware(req, res, next) {
-    if (req.url.startsWith('/__get-internal-source')) {
-      const fileName = req.query.fileName;
-      const id = fileName.match(/webpack-internal:\/\/\/(.+)/)[1];
-      if (!id || !server._stats) {
-        next();
-      }
-
-      const source = getSourceById(server, id);
-      const sourceMapURL = `//# sourceMappingURL=${base64SourceMap(source)}`;
-      const sourceURL = `//# sourceURL=webpack-internal:///${module.id}`;
-      res.end(`${source.source()}\n${sourceMapURL}\n${sourceURL}`);
-    } else {
-      next();
-    }
-  };
-};

package/lib/webpack/react-dev-utils-webpack5/formatWebpackMessages.js

@@ -1,138 +0,0 @@
-/**
- * Copyright (c) 2015-present, Facebook, Inc.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-/* eslint-disable */
-/*
- * THIS FILE IS MODIFIED FOR DOCUSAURUS
- * the above copyright header must be preserved for license compliance.
- */
-
-/*
-Implementation has been copied from https://github.com/facebook/create-react-app/pull/10656
- */
-
-const friendlySyntaxErrorLabel = 'Syntax error:';
-
-function isLikelyASyntaxError(message) {
-  return message.indexOf(friendlySyntaxErrorLabel) !== -1;
-}
-
-// Cleans up webpack error messages.
-function formatMessage(message) {
-  let lines = [];
-
-  // modified for Docusaurus => see https://github.com/facebook/create-react-app/pull/10656
-  if (typeof message === 'string') {
-    lines = message.split('\n');
-  } else if ('message' in message) {
-    lines = message['message'].split('\n');
-  } else if (Array.isArray(message)) {
-    message.forEach((message) => {
-      if ('message' in message) {
-        lines = message['message'].split('\n');
-      }
-    });
-  }
-
-  // Strip webpack-added headers off errors/warnings
-  // https://github.com/webpack/webpack/blob/master/lib/ModuleError.js
-  lines = lines.filter((line) => !/Module [A-z ]+\(from/.test(line));
-
-  // Transform parsing error into syntax error
-  // TODO: move this to our ESLint formatter?
-  lines = lines.map((line) => {
-    const parsingError = /Line (\d+):(?:(\d+):)?\s*Parsing error: (.+)$/.exec(
-      line,
-    );
-    if (!parsingError) {
-      return line;
-    }
-    const [, errorLine, errorColumn, errorMessage] = parsingError;
-    return `${friendlySyntaxErrorLabel} ${errorMessage} (${errorLine}:${errorColumn})`;
-  });
-
-  message = lines.join('\n');
-  // Smoosh syntax errors (commonly found in CSS)
-  message = message.replace(
-    /SyntaxError\s+\((\d+):(\d+)\)\s*(.+?)\n/g,
-    `${friendlySyntaxErrorLabel} $3 ($1:$2)\n`,
-  );
-  // Clean up export errors
-  message = message.replace(
-    /^.*export '(.+?)' was not found in '(.+?)'.*$/gm,
-    `Attempted import error: '$1' is not exported from '$2'.`,
-  );
-  message = message.replace(
-    /^.*export 'default' \(imported as '(.+?)'\) was not found in '(.+?)'.*$/gm,
-    `Attempted import error: '$2' does not contain a default export (imported as '$1').`,
-  );
-  message = message.replace(
-    /^.*export '(.+?)' \(imported as '(.+?)'\) was not found in '(.+?)'.*$/gm,
-    `Attempted import error: '$1' is not exported from '$3' (imported as '$2').`,
-  );
-  lines = message.split('\n');
-
-  // Remove leading newline
-  if (lines.length > 2 && lines[1].trim() === '') {
-    lines.splice(1, 1);
-  }
-  // Clean up file name
-  lines[0] = lines[0].replace(/^(.*) \d+:\d+-\d+$/, '$1');
-
-  // Cleans up verbose "module not found" messages for files and packages.
-  if (lines[1] && lines[1].indexOf('Module not found: ') === 0) {
-    lines = [
-      lines[0],
-      lines[1]
-        .replace('Error: ', '')
-        .replace('Module not found: Cannot find file:', 'Cannot find file:'),
-    ];
-  }
-
-  // Add helpful message for users trying to use Sass for the first time
-  if (lines[1] && lines[1].match(/Cannot find module.+node-sass/)) {
-    lines[1] = 'To import Sass files, you first need to install node-sass.\n';
-    lines[1] +=
-      'Run `npm install node-sass` or `yarn add node-sass` inside your workspace.';
-  }
-
-  message = lines.join('\n');
-  // Internal stacks are generally useless so we strip them... with the
-  // exception of stacks containing `webpack:` because they're normally
-  // from user code generated by webpack. For more information see
-  // https://github.com/facebook/create-react-app/pull/1050
-  message = message.replace(
-    /^\s*at\s((?!webpack:).)*:\d+:\d+[\s)]*(\n|$)/gm,
-    '',
-  ); // at ... ...:x:y
-  message = message.replace(/^\s*at\s<anonymous>(\n|$)/gm, ''); // at <anonymous>
-  lines = message.split('\n');
-
-  // Remove duplicated newlines
-  lines = lines.filter(
-    (line, index, arr) =>
-      index === 0 ||
-      line.trim() !== '' ||
-      line.trim() !== arr[index - 1].trim(),
-  );
-
-  // Reassemble the message
-  message = lines.join('\n');
-  return message.trim();
-}
-
-function formatWebpackMessages(json) {
-  const formattedErrors = json.errors.map(formatMessage);
-  const formattedWarnings = json.warnings.map(formatMessage);
-  const result = {errors: formattedErrors, warnings: formattedWarnings};
-  if (result.errors.some(isLikelyASyntaxError)) {
-    // If there are any syntax errors, show just them.
-    result.errors = result.errors.filter(isLikelyASyntaxError);
-  }
-  return result;
-}
-
-module.exports = formatWebpackMessages;