@docusaurus/plugin-content-docs 0.0.0-4607 → 0.0.0-4611

package/lib/cli.js

@@ -26,8 +26,8 @@ async function createVersionedSidebarFile({ siteDir, pluginId, sidebarPath, vers
     if (shouldCreateVersionedSidebarFile) {
         const versionedSidebarsDir = (0, versions_1.getVersionedSidebarsDirPath)(siteDir, pluginId);
         const newSidebarFile = path_1.default.join(versionedSidebarsDir, `version-${version}-sidebars.json`);
-        fs_extra_1.default.ensureDirSync(path_1.default.dirname(newSidebarFile));
-        fs_extra_1.default.writeFileSync(newSidebarFile, `${JSON.stringify(sidebars, null, 2)}\n`, 'utf8');
+        await fs_extra_1.default.ensureDir(path_1.default.dirname(newSidebarFile));
+        await fs_extra_1.default.writeFile(newSidebarFile, `${JSON.stringify(sidebars, null, 2)}\n`, 'utf8');
     }
 }
 // Tests depend on non-default export for mocking.
@@ -56,8 +56,8 @@ async function cliDocsVersionCommand(version, siteDir, pluginId, options) {
     // Load existing versions.
     let versions = [];
     const versionsJSONFile = (0, versions_1.getVersionsFilePath)(siteDir, pluginId);
-    if (fs_extra_1.default.existsSync(versionsJSONFile)) {
-        versions = JSON.parse(fs_extra_1.default.readFileSync(versionsJSONFile, 'utf8'));
+    if (await fs_extra_1.default.pathExists(versionsJSONFile)) {
+        versions = JSON.parse(await fs_extra_1.default.readFile(versionsJSONFile, 'utf8'));
     }
     // Check if version already exists.
     if (versions.includes(version)) {
@@ -66,10 +66,11 @@ async function cliDocsVersionCommand(version, siteDir, pluginId, options) {
     const { path: docsPath, sidebarPath } = options;
     // Copy docs files.
     const docsDir = path_1.default.join(siteDir, docsPath);
-    if (fs_extra_1.default.existsSync(docsDir) && fs_extra_1.default.readdirSync(docsDir).length > 0) {
+    if ((await fs_extra_1.default.pathExists(docsDir)) &&
+        (await fs_extra_1.default.readdir(docsDir)).length > 0) {
         const versionedDir = (0, versions_1.getVersionedDocsDirPath)(siteDir, pluginId);
         const newVersionDir = path_1.default.join(versionedDir, `version-${version}`);
-        fs_extra_1.default.copySync(docsDir, newVersionDir);
+        await fs_extra_1.default.copy(docsDir, newVersionDir);
     }
     else {
         throw new Error(`${pluginIdLogPrefix}: there is no docs to version!`);
@@ -82,8 +83,8 @@ async function cliDocsVersionCommand(version, siteDir, pluginId, options) {
     });
     // Update versions.json file.
     versions.unshift(version);
-    fs_extra_1.default.ensureDirSync(path_1.default.dirname(versionsJSONFile));
-    fs_extra_1.default.writeFileSync(versionsJSONFile, `${JSON.stringify(versions, null, 2)}\n`);
+    await fs_extra_1.default.ensureDir(path_1.default.dirname(versionsJSONFile));
+    await fs_extra_1.default.writeFile(versionsJSONFile, `${JSON.stringify(versions, null, 2)}\n`);
     logger_1.default.success `name=${pluginIdLogPrefix}: version name=${version} created!`;
 }
 exports.cliDocsVersionCommand = cliDocsVersionCommand;

package/lib/docs.js

@@ -11,7 +11,6 @@ const tslib_1 = require("tslib");
 const path_1 = (0, tslib_1.__importDefault)(require("path"));
 const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
 const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
-const lodash_1 = require("lodash");
 const utils_1 = require("@docusaurus/utils");
 const lastUpdate_1 = require("./lastUpdate");
 const slug_1 = (0, tslib_1.__importDefault)(require("./slug"));
@@ -285,9 +284,9 @@ exports.getDocIds = getDocIds;
 // versioned doc ids ("id" should be removed & "versionedId" should be renamed
 // to "id")
 function createDocsByIdIndex(docs) {
-    return {
-        ...(0, lodash_1.keyBy)(docs, (doc) => doc.unversionedId),
-        ...(0, lodash_1.keyBy)(docs, (doc) => doc.id),
-    };
+    return Object.fromEntries(docs.flatMap((doc) => [
+        [doc.unversionedId, doc],
+        [doc.id, doc],
+    ]));
 }
 exports.createDocsByIdIndex = createDocsByIdIndex;

package/lib/globalData.js

@@ -7,7 +7,8 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.toGlobalDataVersion = exports.toGlobalSidebars = exports.toGlobalDataGeneratedIndex = exports.toGlobalDataDoc = void 0;
-const lodash_1 = require("lodash");
+const tslib_1 = require("tslib");
+const lodash_1 = (0, tslib_1.__importDefault)(require("lodash"));
 const utils_1 = require("@docusaurus/utils");
 const utils_2 = require("./sidebars/utils");
 function toGlobalDataDoc(doc) {
@@ -28,7 +29,7 @@ function toGlobalDataGeneratedIndex(doc) {
 exports.toGlobalDataGeneratedIndex = toGlobalDataGeneratedIndex;
 function toGlobalSidebars(sidebars, version) {
     const { getFirstLink } = (0, utils_2.createSidebarsUtils)(sidebars);
-    return (0, lodash_1.mapValues)(sidebars, (sidebar, sidebarId) => {
+    return lodash_1.default.mapValues(sidebars, (sidebar, sidebarId) => {
         const firstLink = getFirstLink(sidebarId);
         if (!firstLink) {
             return {};

package/lib/index.js

@@ -16,7 +16,6 @@ const docs_1 = require("./docs");
 const versions_1 = require("./versions");
 const cli_1 = require("./cli");
 const constants_1 = require("./constants");
-const lodash_1 = require("lodash");
 const globalData_1 = require("./globalData");
 const props_1 = require("./props");
 const translations_1 = require("./translations");
@@ -199,7 +198,7 @@ async function pluginContentDocs(context, options) {
             const { rehypePlugins, remarkPlugins, beforeDefaultRehypePlugins, beforeDefaultRemarkPlugins, } = options;
             function getSourceToPermalink() {
                 const allDocs = content.loadedVersions.flatMap((v) => v.docs);
-                return (0, lodash_1.mapValues)((0, lodash_1.keyBy)(allDocs, (d) => d.source), (d) => d.permalink);
+                return Object.fromEntries(allDocs.map(({ source, permalink }) => [source, permalink]));
             }
             const docsMarkdownOptions = {
                 siteDir,
@@ -237,6 +236,11 @@ async function pluginContentDocs(context, options) {
                                     const aliasedPath = (0, utils_1.aliasedSitePath)(mdxPath, siteDir);
                                     return path_1.default.join(dataDir, `${(0, utils_1.docuHash)(aliasedPath)}.json`);
                                 },
+                                // Assets allow to convert some relative images paths to
+                                // require(...) calls
+                                createAssets: ({ frontMatter, }) => ({
+                                    image: frontMatter.image,
+                                }),
                             },
                         },
                         {

package/lib/props.js

@@ -7,7 +7,8 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.toTagDocListProp = exports.toVersionMetadataProp = exports.toSidebarsProp = void 0;
-const lodash_1 = require("lodash");
+const tslib_1 = require("tslib");
+const lodash_1 = (0, tslib_1.__importDefault)(require("lodash"));
 const docs_1 = require("./docs");
 function toSidebarsProp(loadedVersion) {
     const docsById = (0, docs_1.createDocsByIdIndex)(loadedVersion.docs);
@@ -63,16 +64,19 @@ Available document ids are:
     // Transform the sidebar so that all sidebar item will be in the
     // form of 'link' or 'category' only.
     // This is what will be passed as props to the UI component.
-    return (0, lodash_1.mapValues)(loadedVersion.sidebars, (items) => items.map(normalizeItem));
+    return lodash_1.default.mapValues(loadedVersion.sidebars, (items) => items.map(normalizeItem));
 }
 exports.toSidebarsProp = toSidebarsProp;
 function toVersionDocsProp(loadedVersion) {
-    return (0, lodash_1.mapValues)((0, lodash_1.keyBy)(loadedVersion.docs, (doc) => doc.unversionedId), (doc) => ({
-        id: doc.unversionedId,
-        title: doc.title,
-        description: doc.description,
-        sidebar: doc.sidebar,
-    }));
+    return Object.fromEntries(loadedVersion.docs.map((doc) => [
+        doc.unversionedId,
+        {
+            id: doc.unversionedId,
+            title: doc.title,
+            description: doc.description,
+            sidebar: doc.sidebar,
+        },
+    ]));
 }
 function toVersionMetadataProp(pluginId, loadedVersion) {
     return {
@@ -90,7 +94,7 @@ function toVersionMetadataProp(pluginId, loadedVersion) {
 exports.toVersionMetadataProp = toVersionMetadataProp;
 function toTagDocListProp({ allTagsPath, tag, docs, }) {
     function toDocListProp() {
-        const list = (0, lodash_1.compact)(tag.docIds.map((id) => docs.find((doc) => doc.id === id)));
+        const list = lodash_1.default.compact(tag.docIds.map((id) => docs.find((doc) => doc.id === id)));
         // Sort docs by title
         list.sort((doc1, doc2) => doc1.title.localeCompare(doc2.title));
         return list.map((doc) => ({

package/lib/sidebars/generator.js

@@ -8,7 +8,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DefaultSidebarItemsGenerator = exports.CategoryMetadataFilenamePattern = exports.CategoryMetadataFilenameBase = void 0;
 const tslib_1 = require("tslib");
-const lodash_1 = require("lodash");
+const lodash_1 = (0, tslib_1.__importDefault)(require("lodash"));
 const utils_1 = require("@docusaurus/utils");
 const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
 const path_1 = (0, tslib_1.__importDefault)(require("path"));
@@ -18,7 +18,7 @@ const BreadcrumbSeparator = '/';
 const docIdPrefix = '$doc$/';
 // Just an alias to the make code more explicit
 function getLocalDocId(docId) {
-    return (0, lodash_1.last)(docId.split('/'));
+    return lodash_1.default.last(docId.split('/'));
 }
 exports.CategoryMetadataFilenameBase = '_category_';
 exports.CategoryMetadataFilenamePattern = '_category_.{json,yml,yaml}';
@@ -177,7 +177,7 @@ const DefaultSidebarItemsGenerator = async ({ numberPrefixParser, isCategoryInde
             }
             return item;
         });
-        const sortedSidebarItems = (0, lodash_1.sortBy)(processedSidebarItems, (item) => item.position);
+        const sortedSidebarItems = lodash_1.default.sortBy(processedSidebarItems, (item) => item.position);
         return sortedSidebarItems.map(({ position, ...item }) => item);
     }
     // TODO: the whole code is designed for pipeline operator

package/lib/sidebars/index.js

@@ -18,7 +18,7 @@ const path_1 = (0, tslib_1.__importDefault)(require("path"));
 const utils_1 = require("@docusaurus/utils");
 const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
 const js_yaml_1 = (0, tslib_1.__importDefault)(require("js-yaml"));
-const lodash_1 = require("lodash");
+const lodash_1 = (0, tslib_1.__importDefault)(require("lodash"));
 const combine_promises_1 = (0, tslib_1.__importDefault)(require("combine-promises"));
 exports.DefaultSidebars = {
     defaultSidebar: [
@@ -41,8 +41,8 @@ async function readCategoriesMetadata(contentPath) {
     const categoryFiles = await (0, utils_1.Globby)('**/_category_.{json,yml,yaml}', {
         cwd: contentPath,
     });
-    const categoryToFile = (0, lodash_1.groupBy)(categoryFiles, path_1.default.dirname);
-    return (0, combine_promises_1.default)((0, lodash_1.mapValues)(categoryToFile, async (files, folder) => {
+    const categoryToFile = lodash_1.default.groupBy(categoryFiles, path_1.default.dirname);
+    return (0, combine_promises_1.default)(lodash_1.default.mapValues(categoryToFile, async (files, folder) => {
         const [filePath] = files;
         if (files.length > 1) {
             logger_1.default.warn `There are more than one category metadata files for path=${folder}: ${files.join(', ')}. The behavior is undetermined.`;
@@ -69,7 +69,7 @@ async function loadSidebarsFileUnsafe(sidebarFilePath) {
     // Non-existent sidebars file: no sidebars
     // Note: this edge case can happen on versioned docs, not current version
     // We avoid creating empty versioned sidebars file with the CLI
-    if (!fs_extra_1.default.existsSync(sidebarFilePath)) {
+    if (!(await fs_extra_1.default.pathExists(sidebarFilePath))) {
         return exports.DisabledSidebars;
     }
     // We don't want sidebars to be cached because of hot reloading.

package/lib/sidebars/normalization.js

@@ -7,8 +7,9 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.normalizeSidebars = exports.normalizeItem = void 0;
+const tslib_1 = require("tslib");
 const utils_1 = require("./utils");
-const lodash_1 = require("lodash");
+const lodash_1 = (0, tslib_1.__importDefault)(require("lodash"));
 function normalizeCategoriesShorthand(sidebar) {
     return Object.entries(sidebar).map(([label, items]) => ({
         type: 'category',
@@ -54,6 +55,6 @@ function normalizeSidebar(sidebar) {
     return normalizedSidebar.flatMap((subItem) => normalizeItem(subItem));
 }
 function normalizeSidebars(sidebars) {
-    return (0, lodash_1.mapValues)(sidebars, normalizeSidebar);
+    return lodash_1.default.mapValues(sidebars, normalizeSidebar);
 }
 exports.normalizeSidebars = normalizeSidebars;

package/lib/sidebars/postProcessor.js

@@ -7,8 +7,9 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.postProcessSidebars = void 0;
+const tslib_1 = require("tslib");
 const utils_1 = require("@docusaurus/utils");
-const lodash_1 = require("lodash");
+const lodash_1 = (0, tslib_1.__importDefault)(require("lodash"));
 function normalizeCategoryLink(category, params) {
     var _a, _b;
     if (((_a = category.link) === null || _a === void 0 ? void 0 : _a.type) === 'generated-index') {
@@ -66,6 +67,6 @@ function postProcessSidebarItem(item, params) {
     return item;
 }
 function postProcessSidebars(sidebars, params) {
-    return (0, lodash_1.mapValues)(sidebars, (sidebar) => sidebar.map((item) => postProcessSidebarItem(item, params)));
+    return lodash_1.default.mapValues(sidebars, (sidebar) => sidebar.map((item) => postProcessSidebarItem(item, params)));
 }
 exports.postProcessSidebars = postProcessSidebars;

package/lib/sidebars/processor.js

@@ -10,11 +10,11 @@ exports.processSidebars = void 0;
 const tslib_1 = require("tslib");
 const generator_1 = require("./generator");
 const validation_1 = require("./validation");
-const lodash_1 = require("lodash");
+const lodash_1 = (0, tslib_1.__importDefault)(require("lodash"));
 const combine_promises_1 = (0, tslib_1.__importDefault)(require("combine-promises"));
 const docs_1 = require("../docs");
 function toSidebarItemsGeneratorDoc(doc) {
-    return (0, lodash_1.pick)(doc, [
+    return lodash_1.default.pick(doc, [
         'id',
         'unversionedId',
         'frontMatter',
@@ -24,14 +24,14 @@ function toSidebarItemsGeneratorDoc(doc) {
     ]);
 }
 function toSidebarItemsGeneratorVersion(version) {
-    return (0, lodash_1.pick)(version, ['versionName', 'contentPath']);
+    return lodash_1.default.pick(version, ['versionName', 'contentPath']);
 }
 // Handle the generation of autogenerated sidebar items and other
 // post-processing checks
 async function processSidebar(unprocessedSidebar, categoriesMetadata, params) {
     const { sidebarItemsGenerator, numberPrefixParser, docs, version, sidebarOptions, } = params;
     // Just a minor lazy transformation optimization
-    const getSidebarItemsGeneratorDocsAndVersion = (0, lodash_1.memoize)(() => ({
+    const getSidebarItemsGeneratorDocsAndVersion = lodash_1.default.memoize(() => ({
         docs: docs.map(toSidebarItemsGeneratorDoc),
         version: toSidebarItemsGeneratorVersion(version),
     }));
@@ -72,7 +72,7 @@ async function processSidebar(unprocessedSidebar, categoriesMetadata, params) {
     return processedSidebar;
 }
 async function processSidebars(unprocessedSidebars, categoriesMetadata, params) {
-    const processedSidebars = await (0, combine_promises_1.default)((0, lodash_1.mapValues)(unprocessedSidebars, (unprocessedSidebar) => processSidebar(unprocessedSidebar, categoriesMetadata, params)));
+    const processedSidebars = await (0, combine_promises_1.default)(lodash_1.default.mapValues(unprocessedSidebars, (unprocessedSidebar) => processSidebar(unprocessedSidebar, categoriesMetadata, params)));
     (0, validation_1.validateSidebars)(processedSidebars);
     return processedSidebars;
 }

package/lib/sidebars/utils.js

@@ -7,7 +7,8 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.toNavigationLink = exports.toDocNavigationLink = exports.createSidebarsUtils = exports.collectSidebarsNavigations = exports.collectSidebarsDocIds = exports.collectSidebarNavigation = exports.collectSidebarDocIds = exports.collectSidebarLinks = exports.collectSidebarCategories = exports.collectSidebarDocItems = exports.transformSidebarItems = exports.isCategoriesShorthand = void 0;
-const lodash_1 = require("lodash");
+const tslib_1 = require("tslib");
+const lodash_1 = (0, tslib_1.__importDefault)(require("lodash"));
 const utils_1 = require("@docusaurus/utils");
 function isCategoriesShorthand(item) {
     return typeof item !== 'string' && !item.type;
@@ -81,11 +82,11 @@ function collectSidebarNavigation(sidebar) {
 }
 exports.collectSidebarNavigation = collectSidebarNavigation;
 function collectSidebarsDocIds(sidebars) {
-    return (0, lodash_1.mapValues)(sidebars, collectSidebarDocIds);
+    return lodash_1.default.mapValues(sidebars, collectSidebarDocIds);
 }
 exports.collectSidebarsDocIds = collectSidebarsDocIds;
 function collectSidebarsNavigations(sidebars) {
-    return (0, lodash_1.mapValues)(sidebars, collectSidebarNavigation);
+    return lodash_1.default.mapValues(sidebars, collectSidebarNavigation);
 }
 exports.collectSidebarsNavigations = collectSidebarsNavigations;
 function createSidebarsUtils(sidebars) {
@@ -172,14 +173,14 @@ function createSidebarsUtils(sidebars) {
     }
     function checkSidebarsDocIds(validDocIds, sidebarFilePath) {
         const allSidebarDocIds = Object.values(sidebarNameToDocIds).flat();
-        const invalidSidebarDocIds = (0, lodash_1.difference)(allSidebarDocIds, validDocIds);
+        const invalidSidebarDocIds = lodash_1.default.difference(allSidebarDocIds, validDocIds);
         if (invalidSidebarDocIds.length > 0) {
             throw new Error(`Invalid sidebar file at "${(0, utils_1.toMessageRelativeFilePath)(sidebarFilePath)}".
 These sidebar document ids do not exist:
 - ${invalidSidebarDocIds.sort().join('\n- ')}
 
 Available document ids are:
-- ${(0, lodash_1.uniq)(validDocIds).sort().join('\n- ')}`);
+- ${lodash_1.default.uniq(validDocIds).sort().join('\n- ')}`);
         }
     }
     function getFirstLink(sidebar) {

package/lib/tags.js

@@ -7,11 +7,12 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getVersionTags = void 0;
+const tslib_1 = require("tslib");
 const utils_1 = require("@docusaurus/utils");
-const lodash_1 = require("lodash");
+const lodash_1 = (0, tslib_1.__importDefault)(require("lodash"));
 function getVersionTags(docs) {
     const groups = (0, utils_1.groupTaggedItems)(docs, (doc) => doc.tags);
-    return (0, lodash_1.mapValues)(groups, (group) => ({
+    return lodash_1.default.mapValues(groups, (group) => ({
         name: group.tag.label,
         docIds: group.items.map((item) => item.id),
         permalink: group.tag.permalink,

package/lib/translations.js

@@ -7,7 +7,8 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.translateLoadedContent = exports.getLoadedContentTranslationFiles = void 0;
-const lodash_1 = require("lodash");
+const tslib_1 = require("tslib");
+const lodash_1 = (0, tslib_1.__importDefault)(require("lodash"));
 const utils_1 = require("./sidebars/utils");
 const utils_2 = require("@docusaurus/utils");
 const constants_1 = require("./constants");
@@ -108,13 +109,13 @@ function getSidebarTranslationFileContent(sidebar, sidebarName) {
         return entries;
     }));
     const links = (0, utils_1.collectSidebarLinks)(sidebar);
-    const linksContent = (0, lodash_1.chain)(links)
-        .keyBy((link) => `sidebar.${sidebarName}.link.${link.label}`)
-        .mapValues((link) => ({
-        message: link.label,
-        description: `The label for link ${link.label} in sidebar ${sidebarName}, linking to ${link.href}`,
-    }))
-        .value();
+    const linksContent = Object.fromEntries(links.map((link) => [
+        `sidebar.${sidebarName}.link.${link.label}`,
+        {
+            message: link.label,
+            description: `The label for link ${link.label} in sidebar ${sidebarName}, linking to ${link.href}`,
+        },
+    ]));
     return (0, utils_2.mergeTranslations)([categoryContent, linksContent]);
 }
 function translateSidebar({ sidebar, sidebarName, sidebarsTranslations, }) {
@@ -163,7 +164,7 @@ function getSidebarsTranslations(version) {
     }));
 }
 function translateSidebars(version, sidebarsTranslations) {
-    return (0, lodash_1.mapValues)(version.sidebars, (sidebar, sidebarName) => translateSidebar({
+    return lodash_1.default.mapValues(version.sidebars, (sidebar, sidebarName) => translateSidebar({
         sidebar,
         sidebarName: getNormalizedSidebarName({
             sidebarName,
@@ -214,7 +215,7 @@ function getLoadedContentTranslationFiles(loadedContent) {
 }
 exports.getLoadedContentTranslationFiles = getLoadedContentTranslationFiles;
 function translateLoadedContent(loadedContent, translationFiles) {
-    const translationFilesMap = (0, lodash_1.keyBy)(translationFiles, (f) => f.path);
+    const translationFilesMap = lodash_1.default.keyBy(translationFiles, (f) => f.path);
     return {
         loadedVersions: translateVersions(loadedContent.loadedVersions, translationFilesMap),
     };

package/lib/versions.js

@@ -12,7 +12,7 @@ const path_1 = (0, tslib_1.__importDefault)(require("path"));
 const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
 const constants_1 = require("./constants");
 const utils_1 = require("@docusaurus/utils");
-const lodash_1 = require("lodash");
+const lodash_1 = (0, tslib_1.__importDefault)(require("lodash"));
 const sidebars_1 = require("./sidebars");
 // retro-compatibility: no prefix for the default plugin id
 function addPluginIdPrefix(fileOrDir, pluginId) {
@@ -236,11 +236,11 @@ function createVersionMetadata({ versionName, versionNames, lastVersionName, con
         contentPathLocalized,
     };
 }
-function checkVersionMetadataPaths({ versionMetadata, context, }) {
+async function checkVersionMetadataPaths({ versionMetadata, context, }) {
     const { versionName, contentPath, sidebarFilePath } = versionMetadata;
     const { siteDir } = context;
     const isCurrentVersion = versionName === constants_1.CURRENT_VERSION_NAME;
-    if (!fs_extra_1.default.existsSync(contentPath)) {
+    if (!(await fs_extra_1.default.pathExists(contentPath))) {
         throw new Error(`The docs folder does not exist for version "${versionName}". A docs folder is expected to be found at ${path_1.default.relative(siteDir, contentPath)}.`);
     }
     // If the current version defines a path to a sidebar file that does not
@@ -250,7 +250,7 @@ function checkVersionMetadataPaths({ versionMetadata, context, }) {
     // See https://github.com/facebook/docusaurus/pull/4775
     if (isCurrentVersion &&
         typeof sidebarFilePath === 'string' &&
-        !fs_extra_1.default.existsSync(sidebarFilePath)) {
+        !(await fs_extra_1.default.pathExists(sidebarFilePath))) {
         throw new Error(`The path to the sidebar file does not exist at "${path_1.default.relative(siteDir, sidebarFilePath)}".
 Please set the docs "sidebarPath" field in your config file to:
 - a sidebars path that exists
@@ -273,7 +273,7 @@ function checkVersionsOptions(availableVersionNames, options) {
         !availableVersionNames.includes(options.lastVersion)) {
         throw new Error(`Docs option lastVersion: ${options.lastVersion} is invalid. ${availableVersionNamesMsg}`);
     }
-    const unknownVersionConfigNames = (0, lodash_1.difference)(Object.keys(options.versions), availableVersionNames);
+    const unknownVersionConfigNames = lodash_1.default.difference(Object.keys(options.versions), availableVersionNames);
     if (unknownVersionConfigNames.length > 0) {
         throw new Error(`Invalid docs option "versions": unknown versions (${unknownVersionConfigNames.join(',')}) found. ${availableVersionNamesMsg}`);
     }
@@ -281,7 +281,7 @@ function checkVersionsOptions(availableVersionNames, options) {
         if (options.onlyIncludeVersions.length === 0) {
             throw new Error(`Invalid docs option "onlyIncludeVersions": an empty array is not allowed, at least one version is needed.`);
         }
-        const unknownOnlyIncludeVersionNames = (0, lodash_1.difference)(options.onlyIncludeVersions, availableVersionNames);
+        const unknownOnlyIncludeVersionNames = lodash_1.default.difference(options.onlyIncludeVersions, availableVersionNames);
         if (unknownOnlyIncludeVersionNames.length > 0) {
             throw new Error(`Invalid docs option "onlyIncludeVersions": unknown versions (${unknownOnlyIncludeVersionNames.join(',')}) found. ${availableVersionNamesMsg}`);
         }
@@ -316,7 +316,7 @@ async function readVersionsMetadata({ context, options, }) {
         context,
         options,
     }));
-    versionsMetadata.forEach((versionMetadata) => checkVersionMetadataPaths({ versionMetadata, context }));
+    await Promise.all(versionsMetadata.map((versionMetadata) => checkVersionMetadataPaths({ versionMetadata, context })));
     return versionsMetadata;
 }
 exports.readVersionsMetadata = readVersionsMetadata;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "0.0.0-4607",
+  "version": "0.0.0-4611",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "exports": {
@@ -23,11 +23,11 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4607",
-    "@docusaurus/logger": "0.0.0-4607",
-    "@docusaurus/mdx-loader": "0.0.0-4607",
-    "@docusaurus/utils": "0.0.0-4607",
-    "@docusaurus/utils-validation": "0.0.0-4607",
+    "@docusaurus/core": "0.0.0-4611",
+    "@docusaurus/logger": "0.0.0-4611",
+    "@docusaurus/mdx-loader": "0.0.0-4611",
+    "@docusaurus/utils": "0.0.0-4611",
+    "@docusaurus/utils-validation": "0.0.0-4611",
     "combine-promises": "^1.1.0",
     "fs-extra": "^10.0.0",
     "import-fresh": "^3.3.0",
@@ -36,11 +36,11 @@
     "remark-admonitions": "^1.2.1",
     "tslib": "^2.3.1",
     "utility-types": "^3.10.0",
-    "webpack": "^5.68.0"
+    "webpack": "^5.69.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4607",
-    "@docusaurus/types": "0.0.0-4607",
+    "@docusaurus/module-type-aliases": "0.0.0-4611",
+    "@docusaurus/types": "0.0.0-4611",
     "@types/js-yaml": "^4.0.5",
     "@types/picomatch": "^2.3.0",
     "commander": "^5.1.0",
@@ -56,5 +56,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "30ca77bf5b904135869292018fa2eec9dd702c59"
+  "gitHead": "6a09283902da2fc8e205f36a018b80d8c8140d1f"
 }

package/src/cli.ts

@@ -47,8 +47,8 @@ async function createVersionedSidebarFile({
       versionedSidebarsDir,
       `version-${version}-sidebars.json`,
     );
-    fs.ensureDirSync(path.dirname(newSidebarFile));
-    fs.writeFileSync(
+    await fs.ensureDir(path.dirname(newSidebarFile));
+    await fs.writeFile(
       newSidebarFile,
       `${JSON.stringify(sidebars, null, 2)}\n`,
       'utf8',
@@ -104,8 +104,8 @@ export async function cliDocsVersionCommand(
   // Load existing versions.
   let versions = [];
   const versionsJSONFile = getVersionsFilePath(siteDir, pluginId);
-  if (fs.existsSync(versionsJSONFile)) {
-    versions = JSON.parse(fs.readFileSync(versionsJSONFile, 'utf8'));
+  if (await fs.pathExists(versionsJSONFile)) {
+    versions = JSON.parse(await fs.readFile(versionsJSONFile, 'utf8'));
   }
 
   // Check if version already exists.
@@ -120,10 +120,13 @@ export async function cliDocsVersionCommand(
   // Copy docs files.
   const docsDir = path.join(siteDir, docsPath);
 
-  if (fs.existsSync(docsDir) && fs.readdirSync(docsDir).length > 0) {
+  if (
+    (await fs.pathExists(docsDir)) &&
+    (await fs.readdir(docsDir)).length > 0
+  ) {
     const versionedDir = getVersionedDocsDirPath(siteDir, pluginId);
     const newVersionDir = path.join(versionedDir, `version-${version}`);
-    fs.copySync(docsDir, newVersionDir);
+    await fs.copy(docsDir, newVersionDir);
   } else {
     throw new Error(`${pluginIdLogPrefix}: there is no docs to version!`);
   }
@@ -137,8 +140,11 @@ export async function cliDocsVersionCommand(
 
   // Update versions.json file.
   versions.unshift(version);
-  fs.ensureDirSync(path.dirname(versionsJSONFile));
-  fs.writeFileSync(versionsJSONFile, `${JSON.stringify(versions, null, 2)}\n`);
+  await fs.ensureDir(path.dirname(versionsJSONFile));
+  await fs.writeFile(
+    versionsJSONFile,
+    `${JSON.stringify(versions, null, 2)}\n`,
+  );
 
   logger.success`name=${pluginIdLogPrefix}: version name=${version} created!`;
 }

package/src/docs.ts

@@ -8,7 +8,6 @@
 import path from 'path';
 import fs from 'fs-extra';
 import logger from '@docusaurus/logger';
-import {keyBy} from 'lodash';
 import {
   aliasedSitePath,
   getEditUrl,
@@ -444,8 +443,10 @@ export function getDocIds(doc: DocMetadataBase): [string, string] {
 export function createDocsByIdIndex<
   Doc extends {id: string; unversionedId: string},
 >(docs: Doc[]): Record<string, Doc> {
-  return {
-    ...keyBy(docs, (doc) => doc.unversionedId),
-    ...keyBy(docs, (doc) => doc.id),
-  };
+  return Object.fromEntries(
+    docs.flatMap((doc) => [
+      [doc.unversionedId, doc],
+      [doc.id, doc],
+    ]),
+  );
 }

package/src/globalData.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {mapValues} from 'lodash';
+import _ from 'lodash';
 import {normalizeUrl} from '@docusaurus/utils';
 import type {Sidebars} from './sidebars/types';
 import {createSidebarsUtils} from './sidebars/utils';
@@ -43,7 +43,7 @@ export function toGlobalSidebars(
   version: LoadedVersion,
 ): Record<string, GlobalSidebar> {
   const {getFirstLink} = createSidebarsUtils(sidebars);
-  return mapValues(sidebars, (sidebar, sidebarId) => {
+  return _.mapValues(sidebars, (sidebar, sidebarId) => {
     const firstLink = getFirstLink(sidebarId);
     if (!firstLink) {
       return {};

package/src/index.ts

@@ -38,11 +38,11 @@ import type {
   DocFile,
   DocsMarkdownOption,
   VersionTag,
+  DocFrontMatter,
 } from './types';
 import type {RuleSetRule} from 'webpack';
 import {cliDocsVersionCommand} from './cli';
 import {VERSIONS_JSON_FILE} from './constants';
-import {keyBy, mapValues} from 'lodash';
 import {toGlobalDataVersion} from './globalData';
 import {toTagDocListProp} from './props';
 import {
@@ -311,9 +311,8 @@ export default async function pluginContentDocs(
 
       function getSourceToPermalink(): SourceToPermalink {
         const allDocs = content.loadedVersions.flatMap((v) => v.docs);
-        return mapValues(
-          keyBy(allDocs, (d) => d.source),
-          (d) => d.permalink,
+        return Object.fromEntries(
+          allDocs.map(({source, permalink}) => [source, permalink]),
         );
       }
 
@@ -362,6 +361,15 @@ export default async function pluginContentDocs(
                   const aliasedPath = aliasedSitePath(mdxPath, siteDir);
                   return path.join(dataDir, `${docuHash(aliasedPath)}.json`);
                 },
+                // Assets allow to convert some relative images paths to
+                // require(...) calls
+                createAssets: ({
+                  frontMatter,
+                }: {
+                  frontMatter: DocFrontMatter;
+                }) => ({
+                  image: frontMatter.image,
+                }),
               },
             },
             {

package/src/props.ts

@@ -22,7 +22,7 @@ import type {
   PropTagDocListDoc,
   PropSidebarItemLink,
 } from '@docusaurus/plugin-content-docs';
-import {compact, keyBy, mapValues} from 'lodash';
+import _ from 'lodash';
 import {createDocsByIdIndex} from './docs';
 
 export function toSidebarsProp(loadedVersion: LoadedVersion): PropSidebars {
@@ -93,18 +93,22 @@ Available document ids are:
   // Transform the sidebar so that all sidebar item will be in the
   // form of 'link' or 'category' only.
   // This is what will be passed as props to the UI component.
-  return mapValues(loadedVersion.sidebars, (items) => items.map(normalizeItem));
+  return _.mapValues(loadedVersion.sidebars, (items) =>
+    items.map(normalizeItem),
+  );
 }
 
 function toVersionDocsProp(loadedVersion: LoadedVersion): PropVersionDocs {
-  return mapValues(
-    keyBy(loadedVersion.docs, (doc) => doc.unversionedId),
-    (doc) => ({
-      id: doc.unversionedId,
-      title: doc.title,
-      description: doc.description,
-      sidebar: doc.sidebar,
-    }),
+  return Object.fromEntries(
+    loadedVersion.docs.map((doc) => [
+      doc.unversionedId,
+      {
+        id: doc.unversionedId,
+        title: doc.title,
+        description: doc.description,
+        sidebar: doc.sidebar,
+      },
+    ]),
   );
 }
 
@@ -135,7 +139,7 @@ export function toTagDocListProp({
   docs: Pick<DocMetadata, 'id' | 'title' | 'description' | 'permalink'>[];
 }): PropTagDocList {
   function toDocListProp(): PropTagDocListDoc[] {
-    const list = compact(
+    const list = _.compact(
       tag.docIds.map((id) => docs.find((doc) => doc.id === id)),
     );
     // Sort docs by title

package/src/sidebars/generator.ts

@@ -13,7 +13,7 @@ import type {
   NormalizedSidebarItem,
   SidebarItemCategoryLinkConfig,
 } from './types';
-import {sortBy, last} from 'lodash';
+import _ from 'lodash';
 import {addTrailingSlash, posixPath} from '@docusaurus/utils';
 import logger from '@docusaurus/logger';
 import path from 'path';
@@ -25,7 +25,7 @@ const docIdPrefix = '$doc$/';
 
 // Just an alias to the make code more explicit
 function getLocalDocId(docId: string): string {
-  return last(docId.split('/'))!;
+  return _.last(docId.split('/'))!;
 }
 
 export const CategoryMetadataFilenameBase = '_category_';
@@ -248,7 +248,7 @@ export const DefaultSidebarItemsGenerator: SidebarItemsGenerator = async ({
       }
       return item;
     });
-    const sortedSidebarItems = sortBy(
+    const sortedSidebarItems = _.sortBy(
       processedSidebarItems,
       (item) => item.position,
     );

package/src/sidebars/index.ts

@@ -17,7 +17,7 @@ import {Globby} from '@docusaurus/utils';
 import logger from '@docusaurus/logger';
 import type {PluginOptions} from '@docusaurus/plugin-content-docs';
 import Yaml from 'js-yaml';
-import {groupBy, mapValues} from 'lodash';
+import _ from 'lodash';
 import combinePromises from 'combine-promises';
 
 export const DefaultSidebars: SidebarsConfig = {
@@ -46,9 +46,9 @@ async function readCategoriesMetadata(contentPath: string) {
   const categoryFiles = await Globby('**/_category_.{json,yml,yaml}', {
     cwd: contentPath,
   });
-  const categoryToFile = groupBy(categoryFiles, path.dirname);
+  const categoryToFile = _.groupBy(categoryFiles, path.dirname);
   return combinePromises(
-    mapValues(categoryToFile, async (files, folder) => {
+    _.mapValues(categoryToFile, async (files, folder) => {
       const [filePath] = files;
       if (files.length > 1) {
         logger.warn`There are more than one category metadata files for path=${folder}: ${files.join(
@@ -85,7 +85,7 @@ export async function loadSidebarsFileUnsafe(
   // Non-existent sidebars file: no sidebars
   // Note: this edge case can happen on versioned docs, not current version
   // We avoid creating empty versioned sidebars file with the CLI
-  if (!fs.existsSync(sidebarFilePath)) {
+  if (!(await fs.pathExists(sidebarFilePath))) {
     return DisabledSidebars;
   }
 

package/src/sidebars/normalization.ts

@@ -17,7 +17,7 @@ import type {
   NormalizedSidebarItemCategory,
 } from './types';
 import {isCategoriesShorthand} from './utils';
-import {mapValues} from 'lodash';
+import _ from 'lodash';
 
 function normalizeCategoriesShorthand(
   sidebar: SidebarCategoriesShorthand,
@@ -81,5 +81,5 @@ function normalizeSidebar(sidebar: SidebarConfig): NormalizedSidebar {
 export function normalizeSidebars(
   sidebars: SidebarsConfig,
 ): NormalizedSidebars {
-  return mapValues(sidebars, normalizeSidebar);
+  return _.mapValues(sidebars, normalizeSidebar);
 }

package/src/sidebars/postProcessor.ts

@@ -15,7 +15,7 @@ import type {
   ProcessedSidebars,
   SidebarItemCategoryLink,
 } from './types';
-import {mapValues} from 'lodash';
+import _ from 'lodash';
 
 function normalizeCategoryLink(
   category: ProcessedSidebarItemCategory,
@@ -88,7 +88,7 @@ export function postProcessSidebars(
   sidebars: ProcessedSidebars,
   params: SidebarProcessorParams,
 ): Sidebars {
-  return mapValues(sidebars, (sidebar) =>
+  return _.mapValues(sidebars, (sidebar) =>
     sidebar.map((item) => postProcessSidebarItem(item, params)),
   );
 }

package/src/sidebars/processor.ts

@@ -21,14 +21,14 @@ import type {
 } from './types';
 import {DefaultSidebarItemsGenerator} from './generator';
 import {validateSidebars} from './validation';
-import {mapValues, memoize, pick} from 'lodash';
+import _ from 'lodash';
 import combinePromises from 'combine-promises';
 import {isCategoryIndex} from '../docs';
 
 function toSidebarItemsGeneratorDoc(
   doc: DocMetadataBase,
 ): SidebarItemsGeneratorDoc {
-  return pick(doc, [
+  return _.pick(doc, [
     'id',
     'unversionedId',
     'frontMatter',
@@ -41,7 +41,7 @@ function toSidebarItemsGeneratorDoc(
 function toSidebarItemsGeneratorVersion(
   version: VersionMetadata,
 ): SidebarItemsGeneratorVersion {
-  return pick(version, ['versionName', 'contentPath']);
+  return _.pick(version, ['versionName', 'contentPath']);
 }
 
 // Handle the generation of autogenerated sidebar items and other
@@ -60,7 +60,7 @@ async function processSidebar(
   } = params;
 
   // Just a minor lazy transformation optimization
-  const getSidebarItemsGeneratorDocsAndVersion = memoize(() => ({
+  const getSidebarItemsGeneratorDocsAndVersion = _.memoize(() => ({
     docs: docs.map(toSidebarItemsGeneratorDoc),
     version: toSidebarItemsGeneratorVersion(version),
   }));
@@ -117,7 +117,7 @@ export async function processSidebars(
   params: SidebarProcessorParams,
 ): Promise<ProcessedSidebars> {
   const processedSidebars = await combinePromises(
-    mapValues(unprocessedSidebars, (unprocessedSidebar) =>
+    _.mapValues(unprocessedSidebars, (unprocessedSidebar) =>
       processSidebar(unprocessedSidebar, categoriesMetadata, params),
     ),
   );

package/src/sidebars/utils.ts

@@ -19,7 +19,7 @@ import type {
   SidebarNavigationItem,
 } from './types';
 
-import {mapValues, difference, uniq} from 'lodash';
+import _ from 'lodash';
 import {getElementsAround, toMessageRelativeFilePath} from '@docusaurus/utils';
 import type {DocMetadataBase, DocNavLink} from '../types';
 
@@ -110,13 +110,13 @@ export function collectSidebarNavigation(
 export function collectSidebarsDocIds(
   sidebars: Sidebars,
 ): Record<string, string[]> {
-  return mapValues(sidebars, collectSidebarDocIds);
+  return _.mapValues(sidebars, collectSidebarDocIds);
 }
 
 export function collectSidebarsNavigations(
   sidebars: Sidebars,
 ): Record<string, SidebarNavigationItem[]> {
-  return mapValues(sidebars, collectSidebarNavigation);
+  return _.mapValues(sidebars, collectSidebarNavigation);
 }
 
 export type SidebarNavigation = {
@@ -276,7 +276,7 @@ export function createSidebarsUtils(sidebars: Sidebars): SidebarsUtils {
 
   function checkSidebarsDocIds(validDocIds: string[], sidebarFilePath: string) {
     const allSidebarDocIds = Object.values(sidebarNameToDocIds).flat();
-    const invalidSidebarDocIds = difference(allSidebarDocIds, validDocIds);
+    const invalidSidebarDocIds = _.difference(allSidebarDocIds, validDocIds);
     if (invalidSidebarDocIds.length > 0) {
       throw new Error(
         `Invalid sidebar file at "${toMessageRelativeFilePath(
@@ -286,7 +286,7 @@ These sidebar document ids do not exist:
 - ${invalidSidebarDocIds.sort().join('\n- ')}
 
 Available document ids are:
-- ${uniq(validDocIds).sort().join('\n- ')}`,
+- ${_.uniq(validDocIds).sort().join('\n- ')}`,
       );
     }
   }

package/src/tags.ts

@@ -7,11 +7,11 @@
 
 import {groupTaggedItems} from '@docusaurus/utils';
 import type {VersionTags, DocMetadata} from './types';
-import {mapValues} from 'lodash';
+import _ from 'lodash';
 
 export function getVersionTags(docs: DocMetadata[]): VersionTags {
   const groups = groupTaggedItems(docs, (doc) => doc.tags);
-  return mapValues(groups, (group) => ({
+  return _.mapValues(groups, (group) => ({
     name: group.tag.label,
     docIds: group.items.map((item) => item.id),
     permalink: group.tag.permalink,

package/src/translations.ts

@@ -13,7 +13,7 @@ import type {
   Sidebars,
 } from './sidebars/types';
 
-import {chain, mapValues, keyBy} from 'lodash';
+import _ from 'lodash';
 import {
   collectSidebarCategories,
   transformSidebarItems,
@@ -146,13 +146,15 @@ function getSidebarTranslationFileContent(
   );
 
   const links = collectSidebarLinks(sidebar);
-  const linksContent: TranslationFileContent = chain(links)
-    .keyBy((link) => `sidebar.${sidebarName}.link.${link.label}`)
-    .mapValues((link) => ({
-      message: link.label,
-      description: `The label for link ${link.label} in sidebar ${sidebarName}, linking to ${link.href}`,
-    }))
-    .value();
+  const linksContent: TranslationFileContent = Object.fromEntries(
+    links.map((link) => [
+      `sidebar.${sidebarName}.link.${link.label}`,
+      {
+        message: link.label,
+        description: `The label for link ${link.label} in sidebar ${sidebarName}, linking to ${link.href}`,
+      },
+    ]),
+  );
 
   return mergeTranslations([categoryContent, linksContent]);
 }
@@ -230,7 +232,7 @@ function translateSidebars(
   version: LoadedVersion,
   sidebarsTranslations: TranslationFileContent,
 ): Sidebars {
-  return mapValues(version.sidebars, (sidebar, sidebarName) =>
+  return _.mapValues(version.sidebars, (sidebar, sidebarName) =>
     translateSidebar({
       sidebar,
       sidebarName: getNormalizedSidebarName({
@@ -302,7 +304,7 @@ export function translateLoadedContent(
   loadedContent: LoadedContent,
   translationFiles: TranslationFile[],
 ): LoadedContent {
-  const translationFilesMap: Record<string, TranslationFile> = keyBy(
+  const translationFilesMap: Record<string, TranslationFile> = _.keyBy(
     translationFiles,
     (f) => f.path,
   );

package/src/versions.ts

@@ -28,7 +28,7 @@ import {
   posixPath,
   DEFAULT_PLUGIN_ID,
 } from '@docusaurus/utils';
-import {difference} from 'lodash';
+import _ from 'lodash';
 import {resolveSidebarPathOption} from './sidebars';
 
 // retro-compatibility: no prefix for the default plugin id
@@ -418,7 +418,7 @@ function createVersionMetadata({
   };
 }
 
-function checkVersionMetadataPaths({
+async function checkVersionMetadataPaths({
   versionMetadata,
   context,
 }: {
@@ -429,7 +429,7 @@ function checkVersionMetadataPaths({
   const {siteDir} = context;
   const isCurrentVersion = versionName === CURRENT_VERSION_NAME;
 
-  if (!fs.existsSync(contentPath)) {
+  if (!(await fs.pathExists(contentPath))) {
     throw new Error(
       `The docs folder does not exist for version "${versionName}". A docs folder is expected to be found at ${path.relative(
         siteDir,
@@ -446,7 +446,7 @@ function checkVersionMetadataPaths({
   if (
     isCurrentVersion &&
     typeof sidebarFilePath === 'string' &&
-    !fs.existsSync(sidebarFilePath)
+    !(await fs.pathExists(sidebarFilePath))
   ) {
     throw new Error(`The path to the sidebar file does not exist at "${path.relative(
       siteDir,
@@ -486,7 +486,7 @@ function checkVersionsOptions(
       `Docs option lastVersion: ${options.lastVersion} is invalid. ${availableVersionNamesMsg}`,
     );
   }
-  const unknownVersionConfigNames = difference(
+  const unknownVersionConfigNames = _.difference(
     Object.keys(options.versions),
     availableVersionNames,
   );
@@ -504,7 +504,7 @@ function checkVersionsOptions(
         `Invalid docs option "onlyIncludeVersions": an empty array is not allowed, at least one version is needed.`,
       );
     }
-    const unknownOnlyIncludeVersionNames = difference(
+    const unknownOnlyIncludeVersionNames = _.difference(
       options.onlyIncludeVersions,
       availableVersionNames,
     );
@@ -585,8 +585,10 @@ export async function readVersionsMetadata({
       options,
     }),
   );
-  versionsMetadata.forEach((versionMetadata) =>
-    checkVersionMetadataPaths({versionMetadata, context}),
+  await Promise.all(
+    versionsMetadata.map((versionMetadata) =>
+      checkVersionMetadataPaths({versionMetadata, context}),
+    ),
   );
   return versionsMetadata;
 }