@docusaurus/plugin-content-docs 0.0.0-5899 → 0.0.0-5900

package/lib/index.js

@@ -30,6 +30,9 @@ async function pluginContentDocs(context, options) {
     const pluginId = options.id;
     const pluginDataDirRoot = path_1.default.join(generatedFilesDir, 'docusaurus-plugin-content-docs');
     const dataDir = path_1.default.join(pluginDataDirRoot, pluginId);
+    // TODO Docusaurus v4 breaking change
+    //  module aliasing should be automatic
+    //  we should never find local absolute FS paths in the codegen registry
     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;

package/lib/routes.js

@@ -19,22 +19,20 @@ function createDocRouteMetadata(docMeta) {
         lastUpdatedAt: docMeta.lastUpdatedAt,
     };
 }
-async function buildVersionCategoryGeneratedIndexRoutes({ version, actions, options, aliasedSource, }) {
-    const slugs = (0, utils_1.createSlugger)();
+async function buildVersionCategoryGeneratedIndexRoutes({ version, options, }) {
     async function buildCategoryGeneratedIndexRoute(categoryGeneratedIndex) {
-        const { sidebar, ...prop } = categoryGeneratedIndex;
-        const propFileName = slugs.slug(`${version.path}-${categoryGeneratedIndex.sidebar}-category-${categoryGeneratedIndex.title}`);
-        const propData = await actions.createData(`${(0, utils_1.docuHash)(`category/${propFileName}`)}.json`, JSON.stringify(prop, null, 2));
         return {
             path: categoryGeneratedIndex.permalink,
             component: options.docCategoryGeneratedIndexComponent,
             exact: true,
-            modules: {
-                categoryGeneratedIndex: aliasedSource(propData),
+            props: {
+                categoryGeneratedIndex,
             },
             // Same as doc, this sidebar route attribute permits to associate this
             // subpage to the given sidebar
-            ...(sidebar && { sidebar }),
+            ...(categoryGeneratedIndex.sidebar && {
+                sidebar: categoryGeneratedIndex.sidebar,
+            }),
         };
     }
     return Promise.all(version.categoryGeneratedIndices.map(buildCategoryGeneratedIndexRoute));
@@ -44,7 +42,7 @@ async function buildVersionDocRoutes({ version, actions, options, }) {
         await actions.createData(
         // Note that this created data path must be in sync with
         // metadataPath provided to mdx-loader.
-        `${(0, utils_1.docuHash)(doc.source)}.json`, JSON.stringify(doc, null, 2));
+        `${(0, utils_1.docuHash)(doc.source)}.json`, doc);
         const docRoute = {
             path: doc.permalink,
             component: options.docItemComponent,
@@ -77,37 +75,33 @@ async function buildVersionSidebarRoute(param) {
     };
 }
 async function buildVersionTagsRoutes(param) {
-    const { version, options, actions, aliasedSource } = param;
+    const { version, options } = param;
     const versionTags = (0, tags_1.getVersionTags)(version.docs);
     async function buildTagsListRoute() {
         // Don't create a tags list page if there's no tag
         if (Object.keys(versionTags).length === 0) {
             return null;
         }
-        const tagsProp = (0, props_1.toTagsListTagsProp)(versionTags);
-        const tagsPropPath = await actions.createData(`${(0, utils_1.docuHash)(`tags-list-${version.versionName}-prop`)}.json`, JSON.stringify(tagsProp, null, 2));
         return {
             path: version.tagsPath,
             exact: true,
             component: options.docTagsListComponent,
-            modules: {
-                tags: aliasedSource(tagsPropPath),
+            props: {
+                tags: (0, props_1.toTagsListTagsProp)(versionTags),
             },
         };
     }
     async function buildTagDocListRoute(tag) {
-        const tagProps = (0, props_1.toTagDocListProp)({
-            allTagsPath: version.tagsPath,
-            tag,
-            docs: version.docs,
-        });
-        const tagPropPath = await actions.createData(`${(0, utils_1.docuHash)(`tag-${tag.permalink}`)}.json`, JSON.stringify(tagProps, null, 2));
         return {
             path: tag.permalink,
             component: options.docTagDocListComponent,
             exact: true,
-            modules: {
-                tag: aliasedSource(tagPropPath),
+            props: {
+                tag: (0, props_1.toTagDocListProp)({
+                    allTagsPath: version.tagsPath,
+                    tag,
+                    docs: version.docs,
+                }),
             },
         };
     }
@@ -118,7 +112,7 @@ async function buildVersionTagsRoutes(param) {
     return lodash_1.default.compact([tagsListRoute, ...allTagsDocListRoutes]);
 }
 async function buildVersionRoutes(param) {
-    const { version, actions, options, aliasedSource } = param;
+    const { version, options } = param;
     async function buildVersionSubRoutes() {
         const [sidebarRoute, tagsRoutes] = await Promise.all([
             buildVersionSidebarRoute(param),
@@ -127,16 +121,15 @@ async function buildVersionRoutes(param) {
         return [sidebarRoute, ...tagsRoutes];
     }
     async function doBuildVersionRoutes() {
-        const versionProp = (0, props_1.toVersionMetadataProp)(options.id, version);
-        const versionPropPath = await actions.createData(`${(0, utils_1.docuHash)(`version-${version.versionName}-metadata-prop`)}.json`, JSON.stringify(versionProp, null, 2));
-        const subRoutes = await buildVersionSubRoutes();
         return {
             path: version.path,
             exact: false,
             component: options.docVersionRootComponent,
-            routes: subRoutes,
-            modules: {
-                version: aliasedSource(versionPropPath),
+            routes: await buildVersionSubRoutes(),
+            props: {
+                // TODO Docusaurus v4 breaking change?
+                //  expose version metadata as route context instead of props
+                version: (0, props_1.toVersionMetadataProp)(options.id, version),
             },
             priority: version.routePriority,
         };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "0.0.0-5899",
+  "version": "0.0.0-5900",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "sideEffects": false,
@@ -35,14 +35,14 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-5899",
-    "@docusaurus/logger": "0.0.0-5899",
-    "@docusaurus/mdx-loader": "0.0.0-5899",
-    "@docusaurus/module-type-aliases": "0.0.0-5899",
-    "@docusaurus/types": "0.0.0-5899",
-    "@docusaurus/utils": "0.0.0-5899",
-    "@docusaurus/utils-common": "0.0.0-5899",
-    "@docusaurus/utils-validation": "0.0.0-5899",
+    "@docusaurus/core": "0.0.0-5900",
+    "@docusaurus/logger": "0.0.0-5900",
+    "@docusaurus/mdx-loader": "0.0.0-5900",
+    "@docusaurus/module-type-aliases": "0.0.0-5900",
+    "@docusaurus/types": "0.0.0-5900",
+    "@docusaurus/utils": "0.0.0-5900",
+    "@docusaurus/utils-common": "0.0.0-5900",
+    "@docusaurus/utils-validation": "0.0.0-5900",
     "@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": "e8e1f914293e8dade7f4e0907d9a00bd1df80470"
+  "gitHead": "8c799b8d6990ec2aea5708a732db09f4dd9e66cc"
 }

package/src/index.ts

@@ -73,6 +73,9 @@ export default async function pluginContentDocs(
     'docusaurus-plugin-content-docs',
   );
   const dataDir = path.join(pluginDataDirRoot, pluginId);
+  // TODO Docusaurus v4 breaking change
+  //  module aliasing should be automatic
+  //  we should never find local absolute FS paths in the codegen registry
   const aliasedSource = (source: string) =>
     `~docs/${posixPath(path.relative(pluginDataDirRoot, source))}`;
 

package/src/routes.ts

@@ -9,7 +9,6 @@ import _ from 'lodash';
 import logger from '@docusaurus/logger';
 import {
   docuHash,
-  createSlugger,
   normalizeUrl,
   aliasedSitePathToRelativePath,
 } from '@docusaurus/utils';
@@ -29,7 +28,6 @@ import type {
   CategoryGeneratedIndexMetadata,
   DocMetadata,
   PluginOptions,
-  PropTagsListPage,
 } from '@docusaurus/plugin-content-docs';
 
 function createDocRouteMetadata(docMeta: DocMetadata): RouteMetadata {
@@ -41,36 +39,23 @@ function createDocRouteMetadata(docMeta: DocMetadata): RouteMetadata {
 
 async function buildVersionCategoryGeneratedIndexRoutes({
   version,
-  actions,
   options,
-  aliasedSource,
 }: BuildVersionRoutesParam): Promise<RouteConfig[]> {
-  const slugs = createSlugger();
-
   async function buildCategoryGeneratedIndexRoute(
     categoryGeneratedIndex: CategoryGeneratedIndexMetadata,
   ): Promise<RouteConfig> {
-    const {sidebar, ...prop} = categoryGeneratedIndex;
-
-    const propFileName = slugs.slug(
-      `${version.path}-${categoryGeneratedIndex.sidebar}-category-${categoryGeneratedIndex.title}`,
-    );
-
-    const propData = await actions.createData(
-      `${docuHash(`category/${propFileName}`)}.json`,
-      JSON.stringify(prop, null, 2),
-    );
-
     return {
       path: categoryGeneratedIndex.permalink,
       component: options.docCategoryGeneratedIndexComponent,
       exact: true,
-      modules: {
-        categoryGeneratedIndex: aliasedSource(propData),
+      props: {
+        categoryGeneratedIndex,
       },
       // Same as doc, this sidebar route attribute permits to associate this
       // subpage to the given sidebar
-      ...(sidebar && {sidebar}),
+      ...(categoryGeneratedIndex.sidebar && {
+        sidebar: categoryGeneratedIndex.sidebar,
+      }),
     };
   }
 
@@ -90,7 +75,7 @@ async function buildVersionDocRoutes({
         // Note that this created data path must be in sync with
         // metadataPath provided to mdx-loader.
         `${docuHash(doc.source)}.json`,
-        JSON.stringify(doc, null, 2),
+        doc,
       );
 
       const docRoute: RouteConfig = {
@@ -131,7 +116,7 @@ async function buildVersionSidebarRoute(param: BuildVersionRoutesParam) {
 async function buildVersionTagsRoutes(
   param: BuildVersionRoutesParam,
 ): Promise<RouteConfig[]> {
-  const {version, options, actions, aliasedSource} = param;
+  const {version, options} = param;
   const versionTags = getVersionTags(version.docs);
 
   async function buildTagsListRoute(): Promise<RouteConfig | null> {
@@ -139,37 +124,27 @@ async function buildVersionTagsRoutes(
     if (Object.keys(versionTags).length === 0) {
       return null;
     }
-    const tagsProp: PropTagsListPage['tags'] = toTagsListTagsProp(versionTags);
-    const tagsPropPath = await actions.createData(
-      `${docuHash(`tags-list-${version.versionName}-prop`)}.json`,
-      JSON.stringify(tagsProp, null, 2),
-    );
     return {
       path: version.tagsPath,
       exact: true,
       component: options.docTagsListComponent,
-      modules: {
-        tags: aliasedSource(tagsPropPath),
+      props: {
+        tags: toTagsListTagsProp(versionTags),
       },
     };
   }
 
   async function buildTagDocListRoute(tag: VersionTag): Promise<RouteConfig> {
-    const tagProps = toTagDocListProp({
-      allTagsPath: version.tagsPath,
-      tag,
-      docs: version.docs,
-    });
-    const tagPropPath = await actions.createData(
-      `${docuHash(`tag-${tag.permalink}`)}.json`,
-      JSON.stringify(tagProps, null, 2),
-    );
     return {
       path: tag.permalink,
       component: options.docTagDocListComponent,
       exact: true,
-      modules: {
-        tag: aliasedSource(tagPropPath),
+      props: {
+        tag: toTagDocListProp({
+          allTagsPath: version.tagsPath,
+          tag,
+          docs: version.docs,
+        }),
       },
     };
   }
@@ -189,7 +164,7 @@ type BuildVersionRoutesParam = Omit<BuildAllRoutesParam, 'versions'> & {
 async function buildVersionRoutes(
   param: BuildVersionRoutesParam,
 ): Promise<RouteConfig> {
-  const {version, actions, options, aliasedSource} = param;
+  const {version, options} = param;
 
   async function buildVersionSubRoutes() {
     const [sidebarRoute, tagsRoutes] = await Promise.all([
@@ -201,19 +176,15 @@ async function buildVersionRoutes(
   }
 
   async function doBuildVersionRoutes(): Promise<RouteConfig> {
-    const versionProp = toVersionMetadataProp(options.id, version);
-    const versionPropPath = await actions.createData(
-      `${docuHash(`version-${version.versionName}-metadata-prop`)}.json`,
-      JSON.stringify(versionProp, null, 2),
-    );
-    const subRoutes = await buildVersionSubRoutes();
     return {
       path: version.path,
       exact: false,
       component: options.docVersionRootComponent,
-      routes: subRoutes,
-      modules: {
-        version: aliasedSource(versionPropPath),
+      routes: await buildVersionSubRoutes(),
+      props: {
+        // TODO Docusaurus v4 breaking change?
+        //  expose version metadata as route context instead of props
+        version: toVersionMetadataProp(options.id, version),
       },
       priority: version.routePriority,
     };