@docusaurus/core 2.0.0-beta.8bda3b2db → 2.0.0-beta.9

package/lib/commands/start.js

@@ -9,23 +9,19 @@ 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 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");
@@ -34,7 +30,7 @@ async function start(siteDir, cliOptions) {
     process.env.BABEL_ENV = 'development';
     console.log(chalk.blue('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,20 +39,20 @@ 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]);
+    const urls = (0, WebpackDevServerUtils_1.prepareUrls)(protocol, host, port);
+    const openUrl = (0, utils_1.normalizeUrl)([urls.localUrlForBrowser, baseUrl]);
     console.log(chalk.cyanBright(`Docusaurus website is running at "${openUrl}".`));
     // 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}".`));
             }
@@ -68,9 +64,9 @@ async function start(siteDir, cliOptions) {
     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 +76,28 @@ 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 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,53 +117,57 @@ 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`.
-            config, false, (_a = props.siteConfig.webpack) === null || _a === void 0 ? void 0 : _a.jsLoader);
+            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': '*',
+        hot: cliOptions.hotOnly ? 'only' : true,
+        liveReload: false,
+        client: {
+            progress: true,
+            overlay: {
+                warnings: false,
+                errors: true,
             },
+        },
+        https: (0, utils_2.getHttpsConfig)(),
+        headers: {
+            'access-control-allow-origin': '*',
+        },
+        devMiddleware: {
             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());
+            // Reduce log verbosity, see https://github.com/facebook/docusaurus/pull/5420#issuecomment-906613105
+            stats: 'summary',
+        },
+        static: {
+            directory: path_1.default.resolve(siteDir, constants_1.STATIC_DIR_NAME),
+            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 },
             },
         },
+        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));
+        },
     };
-    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()) {
@@ -173,18 +178,15 @@ async function start(siteDir, cliOptions) {
             process.exit(0);
         });
     }
-    const devServer = new webpack_dev_server_1.default(compiler, devServerConfig);
-    devServer.listen(port, host, (err) => {
-        if (err) {
-            console.log(err);
-        }
+    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

@@ -9,14 +9,14 @@ 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 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 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,32 +37,32 @@ 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 '';
     })
         .filter((plugin) => plugin !== '');
 }
 exports.getPluginNames = getPluginNames;
-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 (!/node_modules|.css|.d.ts|.d.map/.test(fullPath)) {
-            results.push(fullPath);
-        }
-    });
-    return results;
-}
 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 = [];
+        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
@@ -104,7 +104,7 @@ 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}`)),
@@ -112,10 +112,10 @@ function colorCode(themePath, plugin) {
 }
 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,
     });
@@ -128,12 +128,12 @@ async function swizzle(siteDir, themeName, componentName, typescript, danger) {
     }
     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;
             }
         });
@@ -190,7 +190,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,7 +199,7 @@ async function swizzle(siteDir, themeName, componentName, typescript, danger) {
         });
         if (mostSuitableMatch !== componentName) {
             mostSuitableComponent = mostSuitableMatch;
-            console.log(chalk.red(`Component "${componentName}" doesn't exists.`), chalk.yellow(`"${mostSuitableComponent}" is swizzled instead of "${componentName}".`));
+            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);
@@ -219,7 +219,7 @@ 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;
                 }
             });
@@ -231,7 +231,7 @@ async function swizzle(siteDir, themeName, componentName, typescript, danger) {
         }
     }
     if (!components.includes(mostSuitableComponent) && !danger) {
-        console.warn(chalk.red(`${mostSuitableComponent} is an internal component, and have a higher breaking change probability. If you want to swizzle it, use the "--danger" flag.`));
+        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);

package/lib/commands/writeHeadingIds.d.ts

@@ -5,8 +5,11 @@
  * 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>;
+declare type Options = {
+    maintainCase?: boolean;
+    overwrite?: boolean;
+};
+export declare function transformMarkdownHeadingLine(line: string, slugger: GithubSlugger, 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,53 +6,54 @@
  * 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 github_slugger_1 = (0, tslib_1.__importDefault)(require("github-slugger"));
+const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
 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();
     return lines.map((line) => {
@@ -64,17 +65,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 +86,26 @@ 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- ')}`));
     }
     else {
-        console.log(chalk_1.default.yellow(`${markdownFiles.length} Markdown files already have explicit heading ids.`));
+        console.log(chalk_1.default.yellow(`${markdownFiles.length} Markdown files already have explicit heading IDs. If you intend to overwrite the existing heading IDs, use the ${chalk_1.default.cyan('--overwrite')} option.`));
     }
 }
 exports.default = writeHeadingIds;

package/lib/commands/writeTranslations.js

@@ -1,11 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+const path_1 = (0, tslib_1.__importDefault)(require("path"));
 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 translations_1 = require("../server/translations/translations");
 const translationsExtractor_1 = require("../server/translations/translationsExtractor");
 const utils_1 = require("../webpack/utils");
+// This is a hack, so that @docusaurus/theme-common translations are extracted!
+// A theme doesn't have a way to express that one of its dependency (like @docusaurus/theme-common) also has translations to extract
+// Instead of introducing a new lifecycle (like plugin.getThemeTranslationPaths() ?)
+// We just make an exception and assume that Docusaurus user is using an official theme
+async function getExtraSourceCodeFilePaths() {
+    try {
+        const themeCommonSourceDir = path_1.default.dirname(require.resolve('@docusaurus/theme-common/lib'));
+        return (0, translationsExtractor_1.globSourceCodeFilePaths)([themeCommonSourceDir]);
+    }
+    catch (e) {
+        return []; // User may not use a Docusaurus official theme? Quite unlikely...
+    }
+}
 async function writePluginTranslationFiles({ siteDir, plugin, locale, options, }) {
     var _a;
     if (plugin.getTranslationFiles) {
@@ -14,7 +28,7 @@ async function writePluginTranslationFiles({ siteDir, plugin, locale, options, }
             content,
         });
         await Promise.all(translationFiles.map(async (translationFile) => {
-            await translations_1.writePluginTranslations({
+            await (0, translations_1.writePluginTranslations)({
                 siteDir,
                 plugin,
                 translationFile,
@@ -26,12 +40,12 @@ async function writePluginTranslationFiles({ siteDir, plugin, locale, options, }
 }
 async function writeTranslations(siteDir, options) {
     var _a;
-    const context = await server_1.loadContext(siteDir, {
+    const context = await (0, server_1.loadContext)(siteDir, {
         customConfigFilePath: options.config,
         locale: options.locale,
     });
-    const pluginConfigs = server_1.loadPluginConfigs(context);
-    const plugins = init_1.default({
+    const pluginConfigs = (0, server_1.loadPluginConfigs)(context);
+    const plugins = (0, init_1.default)({
         pluginConfigs,
         context,
     });
@@ -40,17 +54,17 @@ async function writeTranslations(siteDir, options) {
         throw new Error(`Can't write-translation for locale "${locale}" that is not in the locale configuration file.
 Available locales are: ${context.i18n.locales.join(',')}.`);
     }
-    const babelOptions = utils_1.getBabelOptions({
+    const babelOptions = (0, utils_1.getBabelOptions)({
         isServer: true,
-        babelOptions: utils_1.getCustomBabelConfigFilePath(siteDir),
+        babelOptions: (0, utils_1.getCustomBabelConfigFilePath)(siteDir),
     });
-    const extractedCodeTranslations = await translationsExtractor_1.extractSiteSourceCodeTranslations(siteDir, plugins, babelOptions);
-    const defaultCodeMessages = await translations_1.getPluginsDefaultCodeTranslationMessages(plugins);
-    const codeTranslations = translations_1.applyDefaultCodeTranslations({
+    const extractedCodeTranslations = await (0, translationsExtractor_1.extractSiteSourceCodeTranslations)(siteDir, plugins, babelOptions, await getExtraSourceCodeFilePaths());
+    const defaultCodeMessages = await (0, translations_1.getPluginsDefaultCodeTranslationMessages)(plugins);
+    const codeTranslations = (0, translations_1.applyDefaultCodeTranslations)({
         extractedCodeTranslations,
         defaultCodeMessages,
     });
-    await translations_1.writeCodeTranslations({ siteDir, locale }, codeTranslations, options);
+    await (0, translations_1.writeCodeTranslations)({ siteDir, locale }, codeTranslations, options);
     await Promise.all(plugins.map(async (plugin) => {
         await writePluginTranslationFiles({ siteDir, plugin, locale, options });
     }));

package/lib/constants.d.ts

@@ -16,3 +16,4 @@ 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";
+export declare const WEBPACK_URL_LOADER_LIMIT: string | number;

package/lib/constants.js

@@ -5,8 +5,9 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+var _a;
 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.WEBPACK_URL_LOADER_LIMIT = 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
@@ -21,3 +22,5 @@ exports.OUTPUT_STATIC_ASSETS_DIR_NAME = 'assets'; // files handled by webpack, h
 exports.THEME_PATH = `${exports.SRC_DIR_NAME}/theme`;
 exports.DEFAULT_PORT = 3000;
 exports.DEFAULT_PLUGIN_ID = 'default';
+// Temporary fix for https://github.com/facebook/docusaurus/issues/5493
+exports.WEBPACK_URL_LOADER_LIMIT = (_a = process.env.WEBPACK_URL_LOADER_LIMIT) !== null && _a !== void 0 ? _a : 10000;