@docusaurus/plugin-content-docs 0.0.0-5962 → 0.0.0-5963

package/lib/index.js

@@ -23,6 +23,25 @@ const globalData_1 = require("./globalData");
 const translations_1 = require("./translations");
 const routes_1 = require("./routes");
 const utils_2 = require("./sidebars/utils");
+// TODO this is bad, we should have a better way to do this (new lifecycle?)
+//  The source to permalink is currently a mutable map passed to the mdx loader
+//  for link resolution
+//  see https://github.com/facebook/docusaurus/pull/10185
+function createSourceToPermalinkHelper() {
+    const sourceToPermalink = new Map();
+    function computeSourceToPermalink(content) {
+        const allDocs = content.loadedVersions.flatMap((v) => v.docs);
+        return new Map(allDocs.map(({ source, permalink }) => [source, permalink]));
+    }
+    // Mutable map update :/
+    function update(content) {
+        sourceToPermalink.clear();
+        computeSourceToPermalink(content).forEach((value, key) => {
+            sourceToPermalink.set(key, value);
+        });
+    }
+    return { get: () => sourceToPermalink, update };
+}
 async function pluginContentDocs(context, options) {
     const { siteDir, generatedFilesDir, baseUrl, siteConfig } = context;
     // Mutate options to resolve sidebar path according to siteDir
@@ -37,6 +56,7 @@ async function pluginContentDocs(context, options) {
     const aliasedSource = (source) => `~docs/${(0, utils_1.posixPath)(path_1.default.relative(pluginDataDirRoot, source))}`;
     // TODO env should be injected into all plugins
     const env = process.env.NODE_ENV;
+    const sourceToPermalinkHelper = createSourceToPermalinkHelper();
     return {
         name: 'docusaurus-plugin-content-docs',
         extendCli(cli) {
@@ -154,6 +174,7 @@ async function pluginContentDocs(context, options) {
             return (0, translations_1.translateLoadedContent)(content, translationFiles);
         },
         async contentLoaded({ content, actions }) {
+            sourceToPermalinkHelper.update(content);
             const versions = content.loadedVersions.map(versions_1.toFullVersion);
             await (0, routes_1.createAllRoutes)({
                 baseUrl,
@@ -174,13 +195,6 @@ async function pluginContentDocs(context, options) {
                 .flatMap(utils_1.getContentPathList)
                 // Trailing slash is important, see https://github.com/facebook/docusaurus/pull/3970
                 .map(utils_1.addTrailingPathSeparator);
-            // TODO this does not re-run when content gets updated in dev!
-            //  it's probably better to restore a mutable cache in the plugin
-            function getSourceToPermalink() {
-                const allDocs = content.loadedVersions.flatMap((v) => v.docs);
-                return Object.fromEntries(allDocs.map(({ source, permalink }) => [source, permalink]));
-            }
-            const sourceToPermalink = getSourceToPermalink();
             function createMDXLoader() {
                 const loaderOptions = {
                     admonitions: options.admonitions,
@@ -207,7 +221,7 @@ async function pluginContentDocs(context, options) {
                         const version = (0, versions_1.getVersionFromSourceFilePath)(sourceFilePath, content.loadedVersions);
                         const permalink = (0, utils_1.resolveMarkdownLinkPathname)(linkPathname, {
                             sourceFilePath,
-                            sourceToPermalink,
+                            sourceToPermalink: sourceToPermalinkHelper.get(),
                             siteDir,
                             contentPaths: version,
                         });

package/lib/types.d.ts

@@ -14,9 +14,6 @@ export type DocFile = {
     source: string;
     content: string;
 };
-export type SourceToPermalink = {
-    [source: string]: string;
-};
 export type VersionTag = TagMetadata & {
     /** All doc ids having this tag. */
     docIds: string[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "0.0.0-5962",
+  "version": "0.0.0-5963",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "sideEffects": false,
@@ -35,14 +35,14 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-5962",
-    "@docusaurus/logger": "0.0.0-5962",
-    "@docusaurus/mdx-loader": "0.0.0-5962",
-    "@docusaurus/module-type-aliases": "0.0.0-5962",
-    "@docusaurus/types": "0.0.0-5962",
-    "@docusaurus/utils": "0.0.0-5962",
-    "@docusaurus/utils-common": "0.0.0-5962",
-    "@docusaurus/utils-validation": "0.0.0-5962",
+    "@docusaurus/core": "0.0.0-5963",
+    "@docusaurus/logger": "0.0.0-5963",
+    "@docusaurus/mdx-loader": "0.0.0-5963",
+    "@docusaurus/module-type-aliases": "0.0.0-5963",
+    "@docusaurus/types": "0.0.0-5963",
+    "@docusaurus/utils": "0.0.0-5963",
+    "@docusaurus/utils-common": "0.0.0-5963",
+    "@docusaurus/utils-validation": "0.0.0-5963",
     "@types/react-router-config": "^5.0.7",
     "combine-promises": "^1.1.0",
     "fs-extra": "^11.1.1",
@@ -66,5 +66,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "35386a1d384d8e8757ef9f993b84dd5accc00e97"
+  "gitHead": "e9090dc8a38a21043b0849887aa7d54d04c4af9f"
 }

package/src/index.ts

@@ -19,6 +19,8 @@ import {
   createSlugger,
   resolveMarkdownLinkPathname,
   DEFAULT_PLUGIN_ID,
+  type SourceToPermalink,
+  type TagsFile,
 } from '@docusaurus/utils';
 import {
   getTagsFile,
@@ -47,7 +49,6 @@ import {
 } from './translations';
 import {createAllRoutes} from './routes';
 import {createSidebarsUtils} from './sidebars/utils';
-import type {TagsFile} from '@docusaurus/utils';
 import type {Options as MDXLoaderOptions} from '@docusaurus/mdx-loader';
 
 import type {
@@ -59,9 +60,32 @@ import type {
   LoadedVersion,
 } from '@docusaurus/plugin-content-docs';
 import type {LoadContext, Plugin} from '@docusaurus/types';
-import type {SourceToPermalink, DocFile, FullVersion} from './types';
+import type {DocFile, FullVersion} from './types';
 import type {RuleSetUseItem} from 'webpack';
 
+// TODO this is bad, we should have a better way to do this (new lifecycle?)
+//  The source to permalink is currently a mutable map passed to the mdx loader
+//  for link resolution
+//  see https://github.com/facebook/docusaurus/pull/10185
+function createSourceToPermalinkHelper() {
+  const sourceToPermalink: SourceToPermalink = new Map();
+
+  function computeSourceToPermalink(content: LoadedContent): SourceToPermalink {
+    const allDocs = content.loadedVersions.flatMap((v) => v.docs);
+    return new Map(allDocs.map(({source, permalink}) => [source, permalink]));
+  }
+
+  // Mutable map update :/
+  function update(content: LoadedContent): void {
+    sourceToPermalink.clear();
+    computeSourceToPermalink(content).forEach((value, key) => {
+      sourceToPermalink.set(key, value);
+    });
+  }
+
+  return {get: () => sourceToPermalink, update};
+}
+
 export default async function pluginContentDocs(
   context: LoadContext,
   options: PluginOptions,
@@ -88,6 +112,8 @@ export default async function pluginContentDocs(
   // TODO env should be injected into all plugins
   const env = process.env.NODE_ENV as DocEnv;
 
+  const sourceToPermalinkHelper = createSourceToPermalinkHelper();
+
   return {
     name: 'docusaurus-plugin-content-docs',
 
@@ -244,6 +270,8 @@ export default async function pluginContentDocs(
     },
 
     async contentLoaded({content, actions}) {
+      sourceToPermalinkHelper.update(content);
+
       const versions: FullVersion[] = content.loadedVersions.map(toFullVersion);
 
       await createAllRoutes({
@@ -274,16 +302,6 @@ export default async function pluginContentDocs(
         // Trailing slash is important, see https://github.com/facebook/docusaurus/pull/3970
         .map(addTrailingPathSeparator);
 
-      // TODO this does not re-run when content gets updated in dev!
-      //  it's probably better to restore a mutable cache in the plugin
-      function getSourceToPermalink(): SourceToPermalink {
-        const allDocs = content.loadedVersions.flatMap((v) => v.docs);
-        return Object.fromEntries(
-          allDocs.map(({source, permalink}) => [source, permalink]),
-        );
-      }
-      const sourceToPermalink = getSourceToPermalink();
-
       function createMDXLoader(): RuleSetUseItem {
         const loaderOptions: MDXLoaderOptions = {
           admonitions: options.admonitions,
@@ -318,7 +336,7 @@ export default async function pluginContentDocs(
             );
             const permalink = resolveMarkdownLinkPathname(linkPathname, {
               sourceFilePath,
-              sourceToPermalink,
+              sourceToPermalink: sourceToPermalinkHelper.get(),
               siteDir,
               contentPaths: version,
             });

package/src/types.ts

@@ -19,10 +19,6 @@ export type DocFile = {
   content: string;
 };
 
-export type SourceToPermalink = {
-  [source: string]: string;
-};
-
 export type VersionTag = TagMetadata & {
   /** All doc ids having this tag. */
   docIds: string[];