@docusaurus/core 0.0.0-4523 → 0.0.0-4527

package/lib/babel/preset.js

@@ -11,7 +11,8 @@ const path_1 = (0, tslib_1.__importDefault)(require("path"));
 function getTransformOptions(isServer) {
     const absoluteRuntimePath = path_1.default.dirname(require.resolve(`@babel/runtime/package.json`));
     return {
-        // All optional newlines and whitespace will be omitted when generating code in compact mode
+        // All optional newlines and whitespace will be omitted when generating code
+        // in compact mode
         compact: true,
         presets: [
             isServer
@@ -46,9 +47,9 @@ function getTransformOptions(isServer) {
                 {
                     corejs: false,
                     helpers: true,
-                    // By default, it assumes @babel/runtime@7.0.0. Since we use >7.0.0, better to
-                    // explicitly specify the version so that it can reuse the helper better
-                    // See https://github.com/babel/babel/issues/10261
+                    // By default, it assumes @babel/runtime@7.0.0. Since we use >7.0.0,
+                    // better to explicitly specify the version so that it can reuse the
+                    // helper better. See https://github.com/babel/babel/issues/10261
                     // eslint-disable-next-line @typescript-eslint/no-var-requires, global-require
                     version: require('@babel/runtime/package.json').version,
                     regenerator: true,

package/lib/client/PendingNavigation.d.ts

@@ -23,9 +23,9 @@ declare class PendingNavigation extends React.Component<Props, State> {
     progressBarTimeout: NodeJS.Timeout | null;
     constructor(props: Props);
     shouldComponentUpdate(nextProps: Props, nextState: State): boolean;
-    clearProgressBarTimeout(): void;
-    startProgressBar(delay: number): void;
-    stopProgressBar(): void;
+    private clearProgressBarTimeout;
+    private startProgressBar;
+    private stopProgressBar;
     render(): JSX.Element;
 }
 declare const _default: React.ComponentClass<Pick<Props, "routes" | "delay">, any> & import("react-router").WithRouterStatics<typeof PendingNavigation>;

package/lib/client/PendingNavigation.js

@@ -27,8 +27,8 @@ class PendingNavigation extends React.Component {
     shouldComponentUpdate(nextProps, nextState) {
         const routeDidChange = nextProps.location !== this.props.location;
         const { routes, delay } = this.props;
-        // If `routeDidChange` is true, means the router is trying to navigate to a new
-        // route. We will preload the new route.
+        // If `routeDidChange` is true, means the router is trying to navigate to a
+        // new route. We will preload the new route.
         if (routeDidChange) {
             const nextLocation = normalizeLocation(nextProps.location);
             this.startProgressBar(delay);

package/lib/client/baseUrlIssueBanner/BaseUrlIssueBanner.d.ts

@@ -11,4 +11,12 @@ declare global {
         __DOCUSAURUS_INSERT_BASEURL_BANNER: boolean;
     }
 }
+/**
+ * We want to help the users with a bad baseUrl configuration (very common
+ * error) Help message is inlined, and hidden if JS or CSS is able to load
+ * Note: it might create false positives (ie network failures): not a big deal
+ * Note: we only inline this for the homepage to avoid polluting all the site's
+ * pages
+ * @see https://github.com/facebook/docusaurus/pull/3621
+ */
 export default function BaseUrlIssueBanner(): JSX.Element | null;

package/lib/client/baseUrlIssueBanner/BaseUrlIssueBanner.js

@@ -74,11 +74,14 @@ function BaseUrlIssueBannerEnabled() {
       <div id={BannerContainerId}/>
     </>);
 }
-// We want to help the users with a bad baseUrl configuration (very common error)
-// Help message is inlined, and hidden if JS or CSS is able to load
-// Note: it might create false positives (ie network failures): not a big deal
-// Note: we only inline this for the homepage to avoid polluting all the site's pages
-// See https://github.com/facebook/docusaurus/pull/3621
+/**
+ * We want to help the users with a bad baseUrl configuration (very common
+ * error) Help message is inlined, and hidden if JS or CSS is able to load
+ * Note: it might create false positives (ie network failures): not a big deal
+ * Note: we only inline this for the homepage to avoid polluting all the site's
+ * pages
+ * @see https://github.com/facebook/docusaurus/pull/3621
+ */
 export default function BaseUrlIssueBanner() {
     const { siteConfig: { baseUrl, baseUrlIssueBanner }, } = useDocusaurusContext();
     const { pathname } = useLocation();

package/lib/client/clientEntry.js

@@ -12,12 +12,14 @@ import ExecutionEnvironment from './exports/ExecutionEnvironment';
 import App from './App';
 import preload from './preload';
 import docusaurus from './docusaurus';
-// Client-side render (e.g: running in browser) to become single-page application (SPA).
+// Client-side render (e.g: running in browser) to become single-page
+// application (SPA).
 if (ExecutionEnvironment.canUseDOM) {
     window.docusaurus = docusaurus;
-    // For production, attempt to hydrate existing markup for performant first-load experience.
+    // For production, attempt to hydrate existing markup for performant
+    // first-load experience.
     // For development, there is no existing markup so we had to render it.
-    // Note that we also preload async component to avoid first-load loading screen.
+    // We also preload async component to avoid first-load loading screen.
     const renderMethod = process.env.NODE_ENV === 'production' ? hydrate : render;
     preload(routes, window.location.pathname).then(() => {
         renderMethod(<BrowserRouter>

package/lib/client/docusaurus.js

@@ -23,7 +23,7 @@ const canPreload = (routePath) => !isSlowConnection() && !loaded[routePath];
 // Remove the last part containing the route hash
 // input: /blog/2018/12/14/Happy-First-Birthday-Slash-fe9
 // output: /blog/2018/12/14/Happy-First-Birthday-Slash
-const removeRouteNameHash = (str) => str.replace(/(-[^-]+)$/, '');
+const removeRouteNameHash = (str) => str.replace(/-[^-]+$/, '');
 const getChunkNamesToLoad = (path) => Object.entries(routesChunkNames)
     .filter(([routeNameWithHash]) => removeRouteNameHash(routeNameWithHash) === path)
     .flatMap(([, routeChunks]) => 
@@ -41,11 +41,13 @@ const docusaurus = {
         const chunkNamesNeeded = matches.flatMap((match) => getChunkNamesToLoad(match.route.path));
         // Prefetch all webpack chunk assets file needed.
         chunkNamesNeeded.forEach((chunkName) => {
-            // "__webpack_require__.gca" is a custom function provided by ChunkAssetPlugin.
-            // Pass it the chunkName or chunkId you want to load and it will return the URL for that chunk.
+            // "__webpack_require__.gca" is a custom function provided by
+            // ChunkAssetPlugin. Pass it the chunkName or chunkId you want to load and
+            // it will return the URL for that chunk.
             // eslint-disable-next-line camelcase
             const chunkAsset = __webpack_require__.gca(chunkName);
-            // In some cases, webpack might decide to optimize further & hence the chunk assets are merged to another chunk/previous chunk.
+            // In some cases, webpack might decide to optimize further & hence the
+            // chunk assets are merged to another chunk/previous chunk.
             // Hence, we can safely filter it out/don't need to load it.
             if (chunkAsset && !/undefined/.test(chunkAsset)) {
                 prefetchHelper(chunkAsset);

package/lib/client/exports/ComponentCreator.js

@@ -32,7 +32,10 @@ function ComponentCreator(path, hash) {
         content.foo: () => import('./doc1.md'),
       }
     - optsModules: ['./Pages.js', './doc1.md']
-    - optsWebpack: [require.resolveWeak('./Pages.js'), require.resolveWeak('./doc1.md')]
+    - optsWebpack: [
+        require.resolveWeak('./Pages.js'),
+        require.resolveWeak('./doc1.md'),
+      ]
     */
     const flatChunkNames = flat(chunkNames);
     Object.keys(flatChunkNames).forEach((key) => {

package/lib/client/exports/Interpolate.js

@@ -26,30 +26,26 @@ export function interpolate(text, values) {
             elements.push(element);
             return ValueFoundMarker;
         }
-        else {
-            return match; // no match? add warning?
-        }
+        return match; // no match? add warning?
     });
     // No interpolation to be done: just return the text
     if (elements.length === 0) {
         return text;
     }
     // Basic string interpolation: returns interpolated string
-    else if (elements.every((el) => typeof el === 'string')) {
+    if (elements.every((el) => typeof el === 'string')) {
         return processedText
             .split(ValueFoundMarker)
             .reduce((str, value, index) => { var _a; return str.concat(value).concat((_a = elements[index]) !== null && _a !== void 0 ? _a : ''); }, '');
     }
     // JSX interpolation: returns ReactNode
-    else {
-        return processedText.split(ValueFoundMarker).reduce((array, value, index) => [
-            ...array,
-            <React.Fragment key={index}>
-          {value}
-          {elements[index]}
-        </React.Fragment>,
-        ], []);
-    }
+    return processedText.split(ValueFoundMarker).reduce((array, value, index) => [
+        ...array,
+        <React.Fragment key={index}>
+        {value}
+        {elements[index]}
+      </React.Fragment>,
+    ], []);
 }
 export default function Interpolate({ children, values, }) {
     if (typeof children !== 'string') {

package/lib/client/exports/Link.js

@@ -57,7 +57,7 @@ function Link({ isNavLink, to, href, activeClassName, isActive, 'data-noBrokenLi
         ioRef.current = new window.IntersectionObserver((entries) => {
             entries.forEach((entry) => {
                 if (el === entry.target) {
-                    // If element is in viewport, stop listening/observing and run callback.
+                    // If element is in viewport, stop observing and run callback.
                     // https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API
                     if (entry.isIntersecting || entry.intersectionRatio > 0) {
                         ioRef.current.unobserve(el);
@@ -72,7 +72,7 @@ function Link({ isNavLink, to, href, activeClassName, isActive, 'data-noBrokenLi
     };
     const handleRef = (ref) => {
         if (IOSupported && ref && isInternal) {
-            // If IO supported and element reference found, setup Observer functionality.
+            // If IO supported and element reference found, set up Observer.
             handleIntersection(ref, () => {
                 if (targetLink != null) {
                     window.docusaurus.prefetch(targetLink);
@@ -109,7 +109,8 @@ function Link({ isNavLink, to, href, activeClassName, isActive, 'data-noBrokenLi
     // eslint-disable-next-line jsx-a11y/anchor-has-content
     <a href={targetLink} {...(targetLinkUnprefixed &&
         !isInternal && { target: '_blank', rel: 'noopener noreferrer' })} {...props}/>) : (<LinkComponent {...props} onMouseEnter={onMouseEnter} innerRef={handleRef} to={targetLink || ''} 
-    // avoid "React does not recognize the `activeClassName` prop on a DOM element"
+    // avoid "React does not recognize the `activeClassName` prop on a DOM
+    // element"
     {...(isNavLink && { isActive, activeClassName })}/>);
 }
 export default Link;

package/lib/client/exports/Translate.js

@@ -22,7 +22,8 @@ export function translate({ message, id }, values) {
     return interpolate(localizedMessage, values);
 }
 // Maybe we'll want to improve this component with additional features
-// Like toggling a translation mode that adds a little translation button near the text?
+// Like toggling a translation mode that adds a little translation button near
+// the text?
 export default function Translate({ children, id, values, }) {
     if (children && typeof children !== 'string') {
         console.warn('Illegal <Translate> children', children);

package/lib/client/exports/browserContext.js

@@ -10,7 +10,8 @@ import React, { useEffect, useState } from 'react';
 // On first client-side render, we need to render exactly as the server rendered
 // isBrowser is set to true only after a successful hydration
 // Note, isBrowser is not part of useDocusaurusContext() for perf reasons
-// Using useDocusaurusContext() (much more common need) should not trigger re-rendering after a successful hydration
+// Using useDocusaurusContext() (much more common need) should not trigger
+// re-rendering after a successful hydration
 export const Context = React.createContext(false);
 export function BrowserContextProvider({ children, }) {
     const [isBrowser, setIsBrowser] = useState(false);

package/lib/client/exports/isInternalUrl.js

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 export function hasProtocol(url) {
-    return /^(\w*:|\/\/)/.test(url) === true;
+    return /^(?:\w*:|\/\/)/.test(url) === true;
 }
 export default function isInternalUrl(url) {
     return typeof url !== 'undefined' && !hasProtocol(url);

package/lib/client/preload.d.ts

@@ -7,7 +7,8 @@
 import { type RouteConfig } from 'react-router-config';
 /**
  * Helper function to make sure all async components for that particular route
- * is preloaded before rendering. This is especially useful to avoid loading screens.
+ * is preloaded before rendering. This is especially useful to avoid loading
+ * screens.
  *
  * @param routes react-router-config
  * @param pathname the route pathname, example: /docs/installation

package/lib/client/preload.js

@@ -7,7 +7,8 @@
 import { matchRoutes } from 'react-router-config';
 /**
  * Helper function to make sure all async components for that particular route
- * is preloaded before rendering. This is especially useful to avoid loading screens.
+ * is preloaded before rendering. This is especially useful to avoid loading
+ * screens.
  *
  * @param routes react-router-config
  * @param pathname the route pathname, example: /docs/installation

package/lib/client/serverEntry.js

@@ -37,7 +37,7 @@ export default async function render(locals) {
     catch (e) {
         logger.error `Docusaurus Node/SSR could not render static page with path path=${locals.path} because of following error:
 ${e.stack}`;
-        const isNotDefinedErrorRegex = /(window|document|localStorage|navigator|alert|location|buffer|self) is not defined/i;
+        const isNotDefinedErrorRegex = /(?:window|document|localStorage|navigator|alert|location|buffer|self) is not defined/i;
         if (isNotDefinedErrorRegex.test(e.message)) {
             logger.info `It looks like you are using code that should run on the client-side only.
 To get around it, try using code=${'<BrowserOnly>'} (path=${'https://docusaurus.io/docs/docusaurus-core/#browseronly'}) or code=${'ExecutionEnvironment'} (path=${'https://docusaurus.io/docs/docusaurus-core/#executionenvironment'}).
@@ -46,7 +46,7 @@ It might also require to wrap your client code in code=${'useEffect'} hook and/o
         throw new Error('Server-side rendering fails due to the error above.');
     }
 }
-// Renderer for static-site-generator-webpack-plugin (async rendering via promises).
+// Renderer for static-site-generator-webpack-plugin (async rendering).
 async function doRender(locals) {
     const { routesLocation, headTags, preBodyTags, postBodyTags, onLinksCollected, baseUrl, ssrTemplate, noIndex, } = locals;
     const location = routesLocation[locals.path];

package/lib/client/theme-fallback/Error/index.js

@@ -25,10 +25,12 @@ function ErrorDisplay({ error, tryAgain }) {
     </div>);
 }
 function Error({ error, tryAgain }) {
-    // We wrap the error in its own error boundary because the layout can actually throw too...
-    // Only the ErrorDisplay component is simple enough to be considered safe to never throw
+    // We wrap the error in its own error boundary because the layout can actually
+    // throw too... Only the ErrorDisplay component is simple enough to be
+    // considered safe to never throw
     return (<ErrorBoundary 
-    // Note: we display the original error here, not the error that we captured in this extra error boundary
+    // Note: we display the original error here, not the error that we
+    // captured in this extra error boundary
     fallback={() => <ErrorDisplay error={error} tryAgain={tryAgain}/>}>
       <Layout title="Page Error">
         <ErrorDisplay error={error} tryAgain={tryAgain}/>

package/lib/commands/build.js

@@ -58,22 +58,20 @@ forceTerminate = true) {
     if (cliOptions.locale) {
         return tryToBuildLocale({ locale: cliOptions.locale, isLastLocale: true });
     }
-    else {
-        if (i18n.locales.length > 1) {
-            logger_1.default.info `Website will be built for all these locales: ${i18n.locales}`;
-        }
-        // We need the default locale to always be the 1st in the list
-        // If we build it last, it would "erase" the localized sites built in sub-folders
-        const orderedLocales = [
-            i18n.defaultLocale,
-            ...i18n.locales.filter((locale) => locale !== i18n.defaultLocale),
-        ];
-        const results = await (0, utils_2.mapAsyncSequential)(orderedLocales, (locale) => {
-            const isLastLocale = orderedLocales.indexOf(locale) === orderedLocales.length - 1;
-            return tryToBuildLocale({ locale, isLastLocale });
-        });
-        return results[0];
+    if (i18n.locales.length > 1) {
+        logger_1.default.info `Website will be built for all these locales: ${i18n.locales}`;
     }
+    // We need the default locale to always be the 1st in the list. If we build it
+    // last, it would "erase" the localized sites built in sub-folders
+    const orderedLocales = [
+        i18n.defaultLocale,
+        ...i18n.locales.filter((locale) => locale !== i18n.defaultLocale),
+    ];
+    const results = await (0, utils_2.mapAsyncSequential)(orderedLocales, (locale) => {
+        const isLastLocale = orderedLocales.indexOf(locale) === orderedLocales.length - 1;
+        return tryToBuildLocale({ locale, isLastLocale });
+    });
+    return results[0];
 }
 exports.default = build;
 async function buildLocale({ siteDir, locale, cliOptions, forceTerminate, isLastLocale, }) {
@@ -93,7 +91,8 @@ async function buildLocale({ siteDir, locale, cliOptions, forceTerminate, isLast
         plugins: [
             // Remove/clean build folders before building bundles.
             new CleanWebpackPlugin_1.default({ verbose: false }),
-            // Visualize size of webpack output files with an interactive zoomable tree map.
+            // Visualize size of webpack output files with an interactive zoomable
+            // tree map.
             cliOptions.bundleAnalyzer && new webpack_bundle_analyzer_1.BundleAnalyzerPlugin(),
             // Generate client manifests file that will be used for server bundle.
             new react_loadable_ssr_addon_v5_slorber_1.default({
@@ -153,7 +152,6 @@ async function buildLocale({ siteDir, locale, cliOptions, forceTerminate, isLast
         if (!plugin.postBuild) {
             return;
         }
-        // The plugin may reference `this`. We manually bind it again to prevent any bugs.
         await plugin.postBuild({ ...props, content: plugin.content });
     }));
     await (0, brokenLinks_1.handleBrokenLinks)({

package/lib/commands/deploy.js

@@ -56,7 +56,7 @@ function hasSSHProtocol(sourceRepoUrl) {
     }
     catch {
         // Fails when there isn't a protocol
-        return /^([\w-]+@)?[\w.-]+:[\w./_-]+(\.git)?/.test(sourceRepoUrl); // git@github.com:facebook/docusaurus.git
+        return /^(?:[\w-]+@)?[\w.-]+:[\w./_-]+/.test(sourceRepoUrl); // git@github.com:facebook/docusaurus.git
     }
 }
 exports.hasSSHProtocol = hasSSHProtocol;
@@ -114,8 +114,8 @@ This behavior can have SEO impacts and create relative link issues.
         shelljs_1.default.echo('Skipping deploy on a pull request.');
         shelljs_1.default.exit(0);
     }
-    // github.io indicates organization repos that deploy via default branch. All others use gh-pages.
-    // Organization deploys looks like:
+    // github.io indicates organization repos that deploy via default branch.
+    // All others use gh-pages. Organization deploys looks like:
     // - Git repo: https://github.com/<organization>/<organization>.github.io
     // - Site url: https://<organization>.github.io
     const isGitHubPagesOrganizationDeploy = projectName.includes('.github.io');
@@ -196,7 +196,7 @@ You can also set the deploymentBranch property in docusaurus.config.js .`);
         }
     };
     if (!cliOptions.skipBuild) {
-        // Build static html files, then push to deploymentBranch branch of specified repo.
+        // Build site, then push to deploymentBranch branch of specified repo.
         try {
             await runDeploy(await (0, build_1.default)(siteDir, cliOptions, false));
         }

package/lib/commands/external.js

@@ -11,7 +11,7 @@ const server_1 = require("../server");
 const init_1 = (0, tslib_1.__importDefault)(require("../server/plugins/init"));
 async function externalCommand(cli, siteDir) {
     const context = await (0, server_1.loadContext)(siteDir);
-    const pluginConfigs = (0, server_1.loadPluginConfigs)(context);
+    const pluginConfigs = await (0, server_1.loadPluginConfigs)(context);
     const plugins = await (0, init_1.default)({ pluginConfigs, context });
     // Plugin Lifecycle - extendCli.
     plugins.forEach((plugin) => {

package/lib/commands/serve.js

@@ -44,8 +44,8 @@ async function serve(siteDir, cliOptions) {
             res.end();
             return;
         }
-        // Remove baseUrl before calling serveHandler
-        // Reason: /baseUrl/ should serve /build/index.html, not /build/baseUrl/index.html (does not exist)
+        // Remove baseUrl before calling serveHandler, because /baseUrl/ should
+        // serve /build/index.html, not /build/baseUrl/index.html (does not exist)
         req.url = (_b = req.url) === null || _b === void 0 ? void 0 : _b.replace(baseUrl, '/');
         (0, serve_handler_1.default)(req, res, {
             cleanUrls: true,

package/lib/commands/swizzle.js

@@ -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\.(?:jsx?|tsx?)/, '')
+    .replace(/\.(?:jsx?|tsx?)/, '');
 function readComponent(themePath) {
     function walk(dir) {
         let results = [];
@@ -109,7 +109,7 @@ function colorCode(themePath, plugin) {
 async function swizzle(siteDir, themeName, componentName, typescript, danger) {
     var _a, _b, _c, _d, _e;
     const context = await (0, server_1.loadContext)(siteDir);
-    const pluginConfigs = (0, server_1.loadPluginConfigs)(context);
+    const pluginConfigs = await (0, server_1.loadPluginConfigs)(context);
     const pluginNames = getPluginNames(pluginConfigs);
     const plugins = await (0, init_1.default)({
         pluginConfigs,
@@ -185,7 +185,8 @@ async function swizzle(siteDir, themeName, componentName, typescript, danger) {
         let score = formattedComponentName.length;
         components.forEach((component) => {
             if (component.toLowerCase() === formattedComponentName.toLowerCase()) {
-                // may be components with same lowercase key, try to match closest component
+                // 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;
@@ -202,7 +203,8 @@ async function swizzle(siteDir, themeName, componentName, typescript, danger) {
     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
+    // 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`];

package/lib/commands/writeHeadingIds.js

@@ -15,7 +15,7 @@ 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);
+    return line.replace(/\[(?<alt>[^\]]+)\]\([^)]+\)/g, (match, p1) => p1);
 }
 function addHeadingId(line, slugger, maintainCase) {
     let headingLevel = 0;
@@ -48,9 +48,7 @@ function transformMarkdownLine(line, slugger, options) {
     if (line.startsWith('##')) {
         return transformMarkdownHeadingLine(line, slugger, options);
     }
-    else {
-        return line;
-    }
+    return line;
 }
 function transformMarkdownLines(lines, options) {
     let inCode = false;
@@ -60,12 +58,10 @@ function transformMarkdownLines(lines, options) {
             inCode = !inCode;
             return line;
         }
-        else {
-            if (inCode) {
-                return line;
-            }
-            return transformMarkdownLine(line, slugger, options);
+        if (inCode) {
+            return line;
         }
+        return transformMarkdownLine(line, slugger, options);
     });
 }
 function transformMarkdownContent(content, options) {
@@ -81,12 +77,15 @@ async function transformMarkdownFile(filepath, options) {
     }
     return undefined;
 }
-// We only handle the "paths to watch" because these are the paths where the markdown files are
-// 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
+/**
+ * We only handle the "paths to watch" because these are the paths where the
+ * markdown files are. 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 (0, server_1.loadContext)(siteDir);
-    const pluginConfigs = (0, server_1.loadPluginConfigs)(context);
+    const pluginConfigs = await (0, server_1.loadPluginConfigs)(context);
     const plugins = await (0, init_1.default)({
         pluginConfigs,
         context,

package/lib/commands/writeTranslations.js

@@ -13,10 +13,13 @@ 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
+/**
+ * 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 `getThemeTranslationPaths()`?)
+ * We just make an exception and assume that user is using an official theme
+ */
 async function getExtraSourceCodeFilePaths() {
     try {
         const themeCommonSourceDir = path_1.default.dirname(require.resolve('@docusaurus/theme-common/lib'));
@@ -50,7 +53,7 @@ async function writeTranslations(siteDir, options) {
         customConfigFilePath: options.config,
         locale: options.locale,
     });
-    const pluginConfigs = (0, server_1.loadPluginConfigs)(context);
+    const pluginConfigs = await (0, server_1.loadPluginConfigs)(context);
     const plugins = await (0, init_1.default)({
         pluginConfigs,
         context,

package/lib/server/brokenLinks.js

@@ -39,10 +39,12 @@ function getPageBrokenLinks({ pagePath, pageLinks, routes, }) {
     }
     return pageLinks.map(resolveLink).filter((l) => isBrokenLink(l.resolvedLink));
 }
-// The route defs can be recursive, and have a parent match-all route
-// We don't want to match broken links like /docs/brokenLink against /docs/*
-// For this reason, we only consider the "final routes", that do not have subroutes
-// We also need to remove the match all 404 route
+/**
+ * The route defs can be recursive, and have a parent match-all route. We don't
+ * want to match broken links like /docs/brokenLink against /docs/*. For this
+ * reason, we only consider the "final routes", that do not have subroutes.
+ * We also need to remove the match all 404 route
+ */
 function filterIntermediateRoutes(routesInput) {
     const routesWithout404 = routesInput.filter((route) => route.path !== '*');
     return (0, utils_2.getAllFinalRoutes)(routesWithout404);
@@ -67,9 +69,11 @@ function getBrokenLinksErrorMessage(allBrokenLinks) {
             .map(brokenLinkMessage)
             .join('\n   -> linking to ')}`;
     }
-    // If there's a broken link appearing very often, it is probably a broken link on the layout!
-    // Add an additional message in such case to help user figure this out.
-    // see https://github.com/facebook/docusaurus/issues/3567#issuecomment-706973805
+    /**
+     * If there's a broken link appearing very often, it is probably a broken link
+     * on the layout. Add an additional message in such case to help user figure
+     * this out. See https://github.com/facebook/docusaurus/issues/3567#issuecomment-706973805
+     */
     function getLayoutBrokenLinksHelpMessage() {
         const flatList = Object.entries(allBrokenLinks).flatMap(([pagePage, brokenLinks]) => brokenLinks.map((brokenLink) => ({ pagePage, brokenLink })));
         const countedBrokenLinks = (0, lodash_1.countBy)(flatList, (item) => item.brokenLink.link);
@@ -121,8 +125,9 @@ async function handleBrokenLinks({ allCollectedLinks, onBrokenLinks, routes, bas
     if (onBrokenLinks === 'ignore') {
         return;
     }
-    // If we link to a file like /myFile.zip, and the file actually exist for the file system
-    // it is not a broken link, it may simply be a link to an existing static file...
+    // If we link to a file like /myFile.zip, and the file actually exist for the
+    // file system. It is not a broken link, it may simply be a link to an
+    // existing static file...
     const allCollectedLinksFiltered = await filterExistingFileLinks({
         allCollectedLinks,
         baseUrl,

package/lib/server/duplicateRoutes.js

@@ -16,10 +16,8 @@ function getAllDuplicateRoutes(pluginsRouteConfigs) {
         if (Object.prototype.hasOwnProperty.call(seenRoutes, route)) {
             return true;
         }
-        else {
-            seenRoutes[route] = true;
-            return false;
-        }
+        seenRoutes[route] = true;
+        return false;
     });
 }
 exports.getAllDuplicateRoutes = getAllDuplicateRoutes;

package/lib/server/i18n.js

@@ -61,22 +61,18 @@ function localizePath({ pathType, path: originalPath, i18n, options = {}, }) {
         ? // By default, we don't localize the path of defaultLocale
             i18n.currentLocale !== i18n.defaultLocale
         : options.localizePath;
-    if (shouldLocalizePath) {
-        // FS paths need special care, for Windows support
-        if (pathType === 'fs') {
-            return path_1.default.join(originalPath, path_1.default.sep, i18n.currentLocale, path_1.default.sep);
-        }
-        // Url paths
-        else if (pathType === 'url') {
-            return (0, utils_1.normalizeUrl)([originalPath, '/', i18n.currentLocale, '/']);
-        }
-        // should never happen
-        else {
-            throw new Error(`Unhandled path type "${pathType}".`);
-        }
-    }
-    else {
+    if (!shouldLocalizePath) {
         return originalPath;
     }
+    // FS paths need special care, for Windows support
+    if (pathType === 'fs') {
+        return path_1.default.join(originalPath, path_1.default.sep, i18n.currentLocale, path_1.default.sep);
+    }
+    // Url paths
+    if (pathType === 'url') {
+        return (0, utils_1.normalizeUrl)([originalPath, '/', i18n.currentLocale, '/']);
+    }
+    // should never happen
+    throw new Error(`Unhandled path type "${pathType}".`);
 }
 exports.localizePath = localizePath;