@docusaurus/core 2.0.0-beta.12faed89d → 2.0.0-beta.14

package/lib/commands/start.js

@@ -8,33 +8,28 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const utils_1 = require("@docusaurus/utils");
-const chalk = require("chalk");
-const chokidar_1 = tslib_1.__importDefault(require("chokidar"));
-const express_1 = tslib_1.__importDefault(require("express"));
-const html_webpack_plugin_1 = tslib_1.__importDefault(require("html-webpack-plugin"));
-const path_1 = tslib_1.__importDefault(require("path"));
+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"));
 const lodash_1 = require("lodash");
-const openBrowser_1 = tslib_1.__importDefault(require("react-dev-utils/openBrowser"));
+const openBrowser_1 = (0, tslib_1.__importDefault)(require("react-dev-utils/openBrowser"));
 const WebpackDevServerUtils_1 = require("react-dev-utils/WebpackDevServerUtils");
-const errorOverlayMiddleware_1 = tslib_1.__importDefault(require("react-dev-utils/errorOverlayMiddleware"));
-// import evalSourceMapMiddleware from 'react-dev-utils/evalSourceMapMiddleware';
-const evalSourceMapMiddleware_1 = tslib_1.__importDefault(require("../webpack/react-dev-utils-webpack5/evalSourceMapMiddleware"));
-const webpack_1 = tslib_1.__importDefault(require("webpack"));
-const webpack_dev_server_1 = tslib_1.__importDefault(require("webpack-dev-server"));
-const webpack_merge_1 = tslib_1.__importDefault(require("webpack-merge"));
-const HotModuleReplacementPlugin_1 = tslib_1.__importDefault(require("webpack/lib/HotModuleReplacementPlugin"));
+const evalSourceMapMiddleware_1 = (0, tslib_1.__importDefault)(require("react-dev-utils/evalSourceMapMiddleware"));
+const webpack_1 = (0, tslib_1.__importDefault)(require("webpack"));
+const webpack_dev_server_1 = (0, tslib_1.__importDefault)(require("webpack-dev-server"));
+const webpack_merge_1 = (0, tslib_1.__importDefault)(require("webpack-merge"));
 const server_1 = require("../server");
-const constants_1 = require("../constants");
-const client_1 = tslib_1.__importDefault(require("../webpack/client"));
+const client_1 = (0, tslib_1.__importDefault)(require("../webpack/client"));
 const utils_2 = require("../webpack/utils");
 const commandUtils_1 = require("./commandUtils");
 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 server_1.load(siteDir, {
+        return (0, server_1.load)(siteDir, {
             customConfigFilePath: cliOptions.config,
             locale: cliOptions.locale,
             localizePath: undefined, // should this be configurable?
@@ -43,34 +38,34 @@ async function start(siteDir, cliOptions) {
     // Process all related files as a prop.
     const props = await loadSite();
     const protocol = process.env.HTTPS === 'true' ? 'https' : 'http';
-    const host = commandUtils_1.getCLIOptionHost(cliOptions.host);
-    const port = await commandUtils_1.getCLIOptionPort(cliOptions.port, host);
+    const host = (0, commandUtils_1.getCLIOptionHost)(cliOptions.host);
+    const port = await (0, commandUtils_1.getCLIOptionPort)(cliOptions.port, host);
     if (port === null) {
         process.exit();
     }
     const { baseUrl, headTags, preBodyTags, postBodyTags } = props;
-    const urls = WebpackDevServerUtils_1.prepareUrls(protocol, host, port);
-    const openUrl = utils_1.normalizeUrl([urls.localUrlForBrowser, baseUrl]);
-    console.log(chalk.cyanBright(`Docusaurus website is running at "${openUrl}".`));
+    const urls = (0, WebpackDevServerUtils_1.prepareUrls)(protocol, host, port);
+    const openUrl = (0, utils_1.normalizeUrl)([urls.localUrlForBrowser, baseUrl]);
+    logger_1.default.success `Docusaurus website is running at path=${openUrl}.`;
     // Reload files processing.
-    const reload = lodash_1.debounce(() => {
+    const reload = (0, lodash_1.debounce)(() => {
         loadSite()
             .then(({ baseUrl: newBaseUrl }) => {
-            const newOpenUrl = utils_1.normalizeUrl([urls.localUrlForBrowser, 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;
     const normalizeToSiteDir = (filepath) => {
         if (filepath && path_1.default.isAbsolute(filepath)) {
-            return utils_1.posixPath(path_1.default.relative(siteDir, filepath));
+            return (0, utils_1.posixPath)(path_1.default.relative(siteDir, filepath));
         }
-        return utils_1.posixPath(filepath);
+        return (0, utils_1.posixPath)(filepath);
     };
     const pluginPaths = []
         .concat(...plugins
@@ -80,21 +75,29 @@ async function start(siteDir, cliOptions) {
     const pathsToWatch = [
         ...pluginPaths,
         props.siteConfigPath,
-        translations_1.getTranslationsLocaleDirPath({
+        (0, translations_1.getTranslationsLocaleDirPath)({
             siteDir,
             locale: props.i18n.currentLocale,
         }),
     ];
-    const fsWatcher = chokidar_1.default.watch(pathsToWatch, {
-        cwd: siteDir,
-        ignoreInitial: true,
+    const pollingOptions = {
         usePolling: !!cliOptions.poll,
         interval: Number.isInteger(cliOptions.poll)
             ? cliOptions.poll
             : undefined,
+    };
+    const httpsConfig = (0, utils_2.getHttpsConfig)();
+    const fsWatcher = chokidar_1.default.watch(pathsToWatch, {
+        cwd: siteDir,
+        ignoreInitial: true,
+        ...{ pollingOptions },
     });
     ['add', 'change', 'unlink', 'addDir', 'unlinkDir'].forEach((event) => fsWatcher.on(event, reload));
-    let config = webpack_merge_1.default(client_1.default(props), {
+    let config = (0, webpack_merge_1.default)((0, client_1.default)(props), {
+        infrastructureLogging: {
+            // Reduce log verbosity, see https://github.com/facebook/docusaurus/pull/5420#issuecomment-906613105
+            level: 'warn',
+        },
         plugins: [
             // Generates an `index.html` file with the <script> injected.
             new html_webpack_plugin_1.default({
@@ -107,8 +110,6 @@ async function start(siteDir, cliOptions) {
                 preBodyTags,
                 postBodyTags,
             }),
-            // This is necessary to emit hot updates for webpack-dev-server.
-            new HotModuleReplacementPlugin_1.default(),
         ],
     });
     // Plugin Lifecycle - configureWebpack and configurePostCss.
@@ -116,75 +117,86 @@ async function start(siteDir, cliOptions) {
         var _a;
         const { configureWebpack, configurePostCss } = plugin;
         if (configurePostCss) {
-            config = utils_2.applyConfigurePostCss(configurePostCss, config);
+            config = (0, utils_2.applyConfigurePostCss)(configurePostCss, config);
         }
         if (configureWebpack) {
-            config = utils_2.applyConfigureWebpack(configureWebpack.bind(plugin), // The plugin lifecycle may reference `this`. // TODO remove this implicit api: inject in callback instead
+            config = (0, utils_2.applyConfigureWebpack)(configureWebpack.bind(plugin), // The plugin lifecycle may reference `this`. // TODO remove this implicit api: inject in callback instead
             config, false, (_a = props.siteConfig.webpack) === null || _a === void 0 ? void 0 : _a.jsLoader, plugin.content);
         }
     });
-    // https://webpack.js.org/configuration/dev-server
-    const devServerConfig = {
-        ...{
-            compress: true,
-            clientLogLevel: 'error',
-            hot: true,
-            hotOnly: cliOptions.hotOnly,
-            // Use 'ws' instead of 'sockjs-node' on server since we're using native
-            // websockets in `webpackHotDevClient`.
-            transportMode: 'ws',
-            // Prevent a WS client from getting injected as we're already including
-            // `webpackHotDevClient`.
-            injectClient: false,
-            quiet: true,
-            https: utils_2.getHttpsConfig(),
-            headers: {
-                'access-control-allow-origin': '*',
-            },
-            publicPath: baseUrl,
-            watchOptions: {
-                ignored: /node_modules/,
-                poll: cliOptions.poll,
-            },
-            historyApiFallback: {
-                rewrites: [{ from: /\/*/, to: baseUrl }],
-            },
-            disableHostCheck: true,
-            // Disable overlay on browser since we use CRA's overlay error reporting.
-            overlay: false,
-            host,
-            before: (app, server) => {
-                app.use(baseUrl, express_1.default.static(path_1.default.resolve(siteDir, constants_1.STATIC_DIR_NAME)));
-                // This lets us fetch source contents from webpack for the error overlay.
-                app.use(evalSourceMapMiddleware_1.default(server));
-                // This lets us open files from the runtime error overlay.
-                app.use(errorOverlayMiddleware_1.default());
-            },
-        },
-    };
-    const compiler = webpack_1.default(config);
+    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.');
+                logger_1.default.error('E2E_TEST: Project has compiler errors.');
                 process.exit(1);
             }
-            console.log('E2E_TEST: Project can compile.');
+            logger_1.default.success('E2E_TEST: Project can compile.');
             process.exit(0);
         });
     }
-    const devServer = new webpack_dev_server_1.default(compiler, devServerConfig);
-    devServer.listen(port, host, (err) => {
-        if (err) {
-            console.log(err);
-        }
+    // https://webpack.js.org/configuration/dev-server
+    const defaultDevServerConfig = {
+        hot: cliOptions.hotOnly ? 'only' : true,
+        liveReload: false,
+        client: {
+            progress: true,
+            overlay: {
+                warnings: false,
+                errors: true,
+            },
+        },
+        headers: {
+            'access-control-allow-origin': '*',
+        },
+        devMiddleware: {
+            publicPath: baseUrl,
+            // Reduce log verbosity, see https://github.com/facebook/docusaurus/pull/5420#issuecomment-906613105
+            stats: 'summary',
+        },
+        static: siteConfig.staticDirectories.map((dir) => ({
+            publicPath: baseUrl,
+            directory: path_1.default.resolve(siteDir, dir),
+            watch: {
+                // Useful options for our own monorepo using symlinks!
+                // See https://github.com/webpack/webpack/issues/11612#issuecomment-879259806
+                followSymlinks: true,
+                ignored: /node_modules\/(?!@docusaurus)/,
+                ...{ pollingOptions },
+            },
+        })),
+        ...(httpsConfig && {
+            server: typeof httpsConfig === 'object'
+                ? {
+                    type: 'https',
+                    options: httpsConfig,
+                }
+                : 'https',
+        }),
+        historyApiFallback: {
+            rewrites: [{ from: /\/*/, to: baseUrl }],
+        },
+        allowedHosts: 'all',
+        host,
+        port,
+        onBeforeSetupMiddleware: (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));
+        },
+    };
+    // 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) {
-            openBrowser_1.default(openUrl);
+            (0, openBrowser_1.default)(openUrl);
         }
     });
     ['SIGINT', 'SIGTERM'].forEach((sig) => {
         process.on(sig, () => {
-            devServer.close();
+            devServer.stop();
             process.exit();
         });
     });

package/lib/commands/swizzle.js

@@ -8,15 +8,15 @@
 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 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 constants_1 = require("../constants");
+const utils_1 = require("@docusaurus/utils");
 const server_1 = require("../server");
-const init_1 = tslib_1.__importDefault(require("../server/plugins/init"));
+const init_1 = (0, tslib_1.__importDefault)(require("../server/plugins/init"));
 const utils_validation_1 = require("@docusaurus/utils-validation");
 function getPluginNames(plugins) {
     return plugins
@@ -37,7 +37,7 @@ function getPluginNames(plugins) {
             if (packagePath === '.') {
                 return pluginPath;
             }
-            return import_fresh_1.default(path_1.default.join(packagePath, 'package.json')).name;
+            return (0, import_fresh_1.default)(path_1.default.join(packagePath, 'package.json')).name;
         }
         return '';
     })
@@ -45,8 +45,8 @@ function getPluginNames(plugins) {
 }
 exports.getPluginNames = getPluginNames;
 const formatComponentName = (componentName) => componentName
-    .replace(/(\/|\\)index.(js|tsx|ts|jsx)/, '')
-    .replace(/.(js|tsx|ts|jsx)/, '');
+    .replace(/(\/|\\)index\.(js|tsx|ts|jsx)/, '')
+    .replace(/\.(js|tsx|ts|jsx)/, '');
 function readComponent(themePath) {
     function walk(dir) {
         let results = [];
@@ -82,20 +82,16 @@ function getComponentName(themePath, plugin, danger) {
 function themeComponents(themePath, plugin) {
     const components = colorCode(themePath, plugin);
     if (components.length === 0) {
-        return `${chalk.red('No component to swizzle.')}`;
+        return 'No component to swizzle.';
     }
-    return `
-${chalk.cyan('Theme components available for swizzle.')}
+    return `Theme components available for swizzle.
 
-${chalk.green('green  =>')} safe: lower breaking change risk
-${chalk.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
@@ -104,18 +100,18 @@ function colorCode(themePath, plugin) {
     const allowedComponent = getSwizzleComponentList
         ? getSwizzleComponentList()
         : [];
-    const [greenComponents, redComponents] = lodash_1.partition(components, (comp) => allowedComponent.includes(comp));
+    const [greenComponents, redComponents] = (0, lodash_1.partition)(components, (comp) => allowedComponent.includes(comp));
     return [
-        ...greenComponents.map((component) => chalk.green(`safe: ${component}`)),
-        ...redComponents.map((component) => chalk.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) {
     var _a, _b, _c, _d, _e;
-    const context = await server_1.loadContext(siteDir);
-    const pluginConfigs = server_1.loadPluginConfigs(context);
+    const context = await (0, server_1.loadContext)(siteDir);
+    const pluginConfigs = (0, server_1.loadPluginConfigs)(context);
     const pluginNames = getPluginNames(pluginConfigs);
-    const plugins = init_1.default({
+    const plugins = (0, init_1.default)({
         pluginConfigs,
         context,
     });
@@ -123,23 +119,23 @@ 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 {
-        pluginModule = import_fresh_1.default(themeName);
+        pluginModule = (0, import_fresh_1.default)(themeName);
     }
     catch {
         let suggestion;
         themeNames.forEach((name) => {
-            if (leven_1.default(name, themeName) < 4) {
+            if ((0, leven_1.default)(name, themeName) < 4) {
                 suggestion = name;
             }
         });
-        chalk.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 = {};
@@ -171,14 +167,14 @@ async function swizzle(siteDir, themeName, componentName, typescript, danger) {
         ? (_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.`));
+        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);
@@ -190,7 +186,7 @@ async function swizzle(siteDir, themeName, componentName, typescript, danger) {
         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);
+                const currentScore = (0, leven_1.default)(formattedComponentName, component);
                 if (currentScore < score) {
                     score = currentScore;
                     mostSuitableMatch = component;
@@ -199,11 +195,12 @@ async function swizzle(siteDir, themeName, componentName, typescript, danger) {
         });
         if (mostSuitableMatch !== componentName) {
             mostSuitableComponent = mostSuitableMatch;
-            console.log(chalk.red(`Component "${componentName}" doesn't exist.`), chalk.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);
-    let toPath = path_1.default.resolve(siteDir, constants_1.THEME_PATH, 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)) {
@@ -219,27 +216,21 @@ async function swizzle(siteDir, themeName, componentName, typescript, danger) {
         else {
             let suggestion;
             components.forEach((name) => {
-                if (leven_1.default(name, mostSuitableComponent) < 3) {
+                if ((0, 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)}`);
+            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.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.blue(mostSuitableComponent
-        ? `${themeName} ${chalk.yellow(mostSuitableComponent)}`
-        : themeName);
-    const toMsg = chalk.cyan(relativeDir);
-    console.log(`\n${chalk.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,9 +4,12 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import GithubSlugger from 'github-slugger';
-export declare function unwrapMarkdownLinks(line: string): string;
-export declare function transformMarkdownHeadingLine(line: string, slugger: GithubSlugger): string;
-export declare function transformMarkdownLine(line: string, slugger: GithubSlugger): string;
-export declare function transformMarkdownContent(content: string): string;
-export default function writeHeadingIds(siteDir: string): Promise<void>;
+import { Slugger } from '@docusaurus/utils';
+declare type Options = {
+    maintainCase?: boolean;
+    overwrite?: boolean;
+};
+export declare function transformMarkdownHeadingLine(line: string, slugger: Slugger, options?: Options): string;
+export declare function transformMarkdownContent(content: string, options?: Options): string;
+export default function writeHeadingIds(siteDir: string, files?: string, options?: Options): Promise<void>;
+export {};

package/lib/commands/writeHeadingIds.js

@@ -6,55 +6,55 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.transformMarkdownContent = exports.transformMarkdownLine = exports.transformMarkdownHeadingLine = exports.unwrapMarkdownLinks = void 0;
+exports.transformMarkdownContent = exports.transformMarkdownHeadingLine = void 0;
 const tslib_1 = require("tslib");
-const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
-const github_slugger_1 = tslib_1.__importDefault(require("github-slugger"));
-const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
+const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
 const server_1 = require("../server");
-const init_1 = tslib_1.__importDefault(require("../server/plugins/init"));
-const lodash_1 = require("lodash");
+const init_1 = (0, tslib_1.__importDefault)(require("../server/plugins/init"));
 const utils_1 = require("@docusaurus/utils");
 const utils_2 = require("../server/utils");
 function unwrapMarkdownLinks(line) {
     return line.replace(/\[([^\]]+)\]\([^)]+\)/g, (match, p1) => p1);
 }
-exports.unwrapMarkdownLinks = unwrapMarkdownLinks;
-function addHeadingId(line, slugger) {
+function addHeadingId(line, slugger, maintainCase) {
     let headingLevel = 0;
     while (line.charAt(headingLevel) === '#') {
         headingLevel += 1;
     }
     const headingText = line.slice(headingLevel).trimEnd();
     const headingHashes = line.slice(0, headingLevel);
-    const slug = slugger.slug(unwrapMarkdownLinks(headingText));
+    const slug = slugger
+        .slug(unwrapMarkdownLinks(headingText).trim(), { maintainCase })
+        .replace(/^-+/, '')
+        .replace(/-+$/, '');
     return `${headingHashes}${headingText} {#${slug}}`;
 }
-function transformMarkdownHeadingLine(line, slugger) {
+function transformMarkdownHeadingLine(line, slugger, options = { maintainCase: false, overwrite: false }) {
+    const { maintainCase = false, overwrite = false } = options;
     if (!line.startsWith('#')) {
         throw new Error(`Line is not a Markdown heading: ${line}.`);
     }
-    const parsedHeading = utils_1.parseMarkdownHeadingId(line);
-    // Do not process if id is already therer
-    if (parsedHeading.id) {
+    const parsedHeading = (0, utils_1.parseMarkdownHeadingId)(line);
+    // Do not process if id is already there
+    if (parsedHeading.id && !overwrite) {
         return line;
     }
-    return addHeadingId(line, slugger);
+    return addHeadingId(parsedHeading.text, slugger, maintainCase);
 }
 exports.transformMarkdownHeadingLine = transformMarkdownHeadingLine;
-function transformMarkdownLine(line, slugger) {
+function transformMarkdownLine(line, slugger, options) {
     // Ignore h1 headings on purpose, as we don't create anchor links for those
     if (line.startsWith('##')) {
-        return transformMarkdownHeadingLine(line, slugger);
+        return transformMarkdownHeadingLine(line, slugger, options);
     }
     else {
         return line;
     }
 }
-exports.transformMarkdownLine = transformMarkdownLine;
-function transformMarkdownLines(lines) {
+function transformMarkdownLines(lines, options) {
     let inCode = false;
-    const slugger = new github_slugger_1.default();
+    const slugger = (0, utils_1.createSlugger)();
     return lines.map((line) => {
         if (line.startsWith('```')) {
             inCode = !inCode;
@@ -64,17 +64,17 @@ function transformMarkdownLines(lines) {
             if (inCode) {
                 return line;
             }
-            return transformMarkdownLine(line, slugger);
+            return transformMarkdownLine(line, slugger, options);
         }
     });
 }
-function transformMarkdownContent(content) {
-    return transformMarkdownLines(content.split('\n')).join('\n');
+function transformMarkdownContent(content, options) {
+    return transformMarkdownLines(content.split('\n'), options).join('\n');
 }
 exports.transformMarkdownContent = transformMarkdownContent;
-async function transformMarkdownFile(filepath) {
+async function transformMarkdownFile(filepath, options) {
     const content = await fs_extra_1.default.readFile(filepath, 'utf8');
-    const updatedContent = transformMarkdownLines(content.split('\n')).join('\n');
+    const updatedContent = transformMarkdownLines(content.split('\n'), options).join('\n');
     if (content !== updatedContent) {
         await fs_extra_1.default.writeFile(filepath, updatedContent);
         return filepath;
@@ -85,26 +85,25 @@ async function transformMarkdownFile(filepath) {
 // Also we don't want to transform the site md docs that do not belong to a content plugin
 // For example ./README.md should not be transformed
 async function getPathsToWatch(siteDir) {
-    const context = await server_1.loadContext(siteDir);
-    const pluginConfigs = server_1.loadPluginConfigs(context);
-    const plugins = await init_1.default({
+    const context = await (0, server_1.loadContext)(siteDir);
+    const pluginConfigs = (0, server_1.loadPluginConfigs)(context);
+    const plugins = (0, init_1.default)({
         pluginConfigs,
         context,
     });
-    return lodash_1.flatten(plugins.map((plugin) => { var _a, _b; return (_b = (_a = plugin === null || plugin === void 0 ? void 0 : plugin.getPathsToWatch) === null || _a === void 0 ? void 0 : _a.call(plugin)) !== null && _b !== void 0 ? _b : []; }));
+    return plugins.flatMap((plugin) => { var _a, _b; return (_b = (_a = plugin === null || plugin === void 0 ? void 0 : plugin.getPathsToWatch) === null || _a === void 0 ? void 0 : _a.call(plugin)) !== null && _b !== void 0 ? _b : []; });
 }
-async function writeHeadingIds(siteDir) {
-    const markdownFiles = await utils_2.safeGlobby(await getPathsToWatch(siteDir), {
+async function writeHeadingIds(siteDir, files, options) {
+    const markdownFiles = await (0, utils_2.safeGlobby)(files ? [files] : await getPathsToWatch(siteDir), {
         expandDirectories: ['**/*.{md,mdx}'],
     });
-    const result = await Promise.all(markdownFiles.map(transformMarkdownFile));
+    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.`));
+        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;