@docusaurus/plugin-content-docs 3.7.0-canary-6228 → 3.7.0-canary-6231

package/lib/index.js

@@ -10,6 +10,7 @@ exports.validateOptions = void 0;
 exports.default = pluginContentDocs;
 const tslib_1 = require("tslib");
 const path_1 = tslib_1.__importDefault(require("path"));
+const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const utils_1 = require("@docusaurus/utils");
@@ -26,6 +27,21 @@ const translations_1 = require("./translations");
 const routes_1 = require("./routes");
 const utils_2 = require("./sidebars/utils");
 const contentHelpers_1 = require("./contentHelpers");
+// MDX loader is not 100% deterministic, leading to cache invalidation issue
+// This permits to invalidate the MDX loader cache entries when content changes
+// Problem documented here: https://github.com/facebook/docusaurus/pull/10934
+// TODO this is not a perfect solution, find better?
+async function createMdxLoaderDependencyFile({ dataDir, options, versionsMetadata, }) {
+    const filePath = path_1.default.join(dataDir, '__mdx-loader-dependency.json');
+    // the cache is invalidated whenever this file content changes
+    const fileContent = {
+        options,
+        versionsMetadata,
+    };
+    await fs_extra_1.default.ensureDir(dataDir);
+    await fs_extra_1.default.writeFile(filePath, JSON.stringify(fileContent));
+    return filePath;
+}
 async function pluginContentDocs(context, options) {
     const { siteDir, generatedFilesDir, baseUrl, siteConfig } = context;
     // Mutate options to resolve sidebar path according to siteDir
@@ -50,6 +66,13 @@ async function pluginContentDocs(context, options) {
         return (0, mdx_loader_1.createMDXLoaderRule)({
             include: contentDirs,
             options: {
+                dependencies: [
+                    await createMdxLoaderDependencyFile({
+                        dataDir,
+                        options,
+                        versionsMetadata,
+                    }),
+                ],
                 useCrossCompilerCache: siteConfig.future.experimental_faster.mdxCrossCompilerCache,
                 admonitions: options.admonitions,
                 remarkPlugins,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "3.7.0-canary-6228",
+  "version": "3.7.0-canary-6231",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "sideEffects": false,
@@ -35,15 +35,15 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "3.7.0-canary-6228",
-    "@docusaurus/logger": "3.7.0-canary-6228",
-    "@docusaurus/mdx-loader": "3.7.0-canary-6228",
-    "@docusaurus/module-type-aliases": "3.7.0-canary-6228",
-    "@docusaurus/theme-common": "3.7.0-canary-6228",
-    "@docusaurus/types": "3.7.0-canary-6228",
-    "@docusaurus/utils": "3.7.0-canary-6228",
-    "@docusaurus/utils-common": "3.7.0-canary-6228",
-    "@docusaurus/utils-validation": "3.7.0-canary-6228",
+    "@docusaurus/core": "3.7.0-canary-6231",
+    "@docusaurus/logger": "3.7.0-canary-6231",
+    "@docusaurus/mdx-loader": "3.7.0-canary-6231",
+    "@docusaurus/module-type-aliases": "3.7.0-canary-6231",
+    "@docusaurus/theme-common": "3.7.0-canary-6231",
+    "@docusaurus/types": "3.7.0-canary-6231",
+    "@docusaurus/utils": "3.7.0-canary-6231",
+    "@docusaurus/utils-common": "3.7.0-canary-6231",
+    "@docusaurus/utils-validation": "3.7.0-canary-6231",
     "@types/react-router-config": "^5.0.7",
     "combine-promises": "^1.1.0",
     "fs-extra": "^11.1.1",
@@ -68,5 +68,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "3f8026882f9caca53ae9d217f12bfc26db79bba3"
+  "gitHead": "6a28543acaedb9fd6b7d7a6731dc9d89f45f5437"
 }

package/src/index.ts

@@ -6,6 +6,7 @@
  */
 
 import path from 'path';
+import fs from 'fs-extra';
 import _ from 'lodash';
 import logger from '@docusaurus/logger';
 import {
@@ -63,6 +64,30 @@ import type {LoadContext, Plugin} from '@docusaurus/types';
 import type {DocFile, FullVersion} from './types';
 import type {RuleSetRule} from 'webpack';
 
+// MDX loader is not 100% deterministic, leading to cache invalidation issue
+// This permits to invalidate the MDX loader cache entries when content changes
+// Problem documented here: https://github.com/facebook/docusaurus/pull/10934
+// TODO this is not a perfect solution, find better?
+async function createMdxLoaderDependencyFile({
+  dataDir,
+  options,
+  versionsMetadata,
+}: {
+  dataDir: string;
+  options: PluginOptions;
+  versionsMetadata: VersionMetadata[];
+}) {
+  const filePath = path.join(dataDir, '__mdx-loader-dependency.json');
+  // the cache is invalidated whenever this file content changes
+  const fileContent = {
+    options,
+    versionsMetadata,
+  };
+  await fs.ensureDir(dataDir);
+  await fs.writeFile(filePath, JSON.stringify(fileContent));
+  return filePath;
+}
+
 export default async function pluginContentDocs(
   context: LoadContext,
   options: PluginOptions,
@@ -107,6 +132,14 @@ export default async function pluginContentDocs(
     return createMDXLoaderRule({
       include: contentDirs,
       options: {
+        dependencies: [
+          await createMdxLoaderDependencyFile({
+            dataDir,
+            options,
+            versionsMetadata,
+          }),
+        ],
+
         useCrossCompilerCache:
           siteConfig.future.experimental_faster.mdxCrossCompilerCache,
         admonitions: options.admonitions,

package/src/plugin-content-docs.d.ts

@@ -20,7 +20,11 @@ declare module '@docusaurus/plugin-content-docs' {
     TagMetadata,
     TagsPluginOptions,
   } from '@docusaurus/utils';
-  import type {Plugin, LoadContext} from '@docusaurus/types';
+  import type {
+    Plugin,
+    LoadContext,
+    OptionValidationContext,
+  } from '@docusaurus/types';
   import type {Overwrite, Required} from 'utility-types';
 
   export type Assets = {
@@ -559,6 +563,10 @@ declare module '@docusaurus/plugin-content-docs' {
     context: LoadContext,
     options: PluginOptions,
   ): Promise<Plugin<LoadedContent>>;
+
+  export function validateOptions(
+    args: OptionValidationContext<Options | undefined, PluginOptions>,
+  ): PluginOptions;
 }
 
 declare module '@theme/DocItem' {