@docusaurus/plugin-content-docs 0.0.0-4837 → 0.0.0-4840

package/lib/cli.d.ts

@@ -4,5 +4,6 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { PathOptions, SidebarOptions } from '@docusaurus/plugin-content-docs';
-export declare function cliDocsVersionCommand(version: string | null | undefined, siteDir: string, pluginId: string, options: PathOptions & SidebarOptions): Promise<void>;
+import type { PluginOptions } from '@docusaurus/plugin-content-docs';
+import type { LoadContext } from '@docusaurus/types';
+export declare function cliDocsVersionCommand(version: string | null | undefined, { id: pluginId, path: docsPath, sidebarPath }: PluginOptions, { siteDir, i18n }: LoadContext): Promise<void>;

package/lib/cli.js

@@ -12,6 +12,7 @@ const versions_1 = require("./versions");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const path_1 = tslib_1.__importDefault(require("path"));
 const sidebars_1 = require("./sidebars");
+const constants_1 = require("./constants");
 const utils_1 = require("@docusaurus/utils");
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 async function createVersionedSidebarFile({ siteDir, pluginId, sidebarPath, version, }) {
@@ -30,7 +31,7 @@ async function createVersionedSidebarFile({ siteDir, pluginId, sidebarPath, vers
     }
 }
 // Tests depend on non-default export for mocking.
-async function cliDocsVersionCommand(version, siteDir, pluginId, options) {
+async function cliDocsVersionCommand(version, { id: pluginId, path: docsPath, sidebarPath }, { siteDir, i18n }) {
     // It wouldn't be very user-friendly to show a [default] log prefix,
     // so we use [docs] instead of [default]
     const pluginIdLogPrefix = pluginId === utils_1.DEFAULT_PLUGIN_ID ? '[docs]' : `[${pluginId}]`;
@@ -62,18 +63,39 @@ async function cliDocsVersionCommand(version, siteDir, pluginId, options) {
     if (versions.includes(version)) {
         throw new Error(`${pluginIdLogPrefix}: this version already exists! Use a version tag that does not already exist.`);
     }
-    const { path: docsPath, sidebarPath } = options;
-    // Copy docs files.
-    const docsDir = path_1.default.resolve(siteDir, docsPath);
-    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}`);
-        await fs_extra_1.default.copy(docsDir, newVersionDir);
-    }
-    else {
-        throw new Error(`${pluginIdLogPrefix}: no docs found in ${docsDir}.`);
+    if (i18n.locales.length > 1) {
+        logger_1.default.info `Versioned docs will be created for the following locales: name=${i18n.locales}`;
     }
+    await Promise.all(i18n.locales.map(async (locale) => {
+        // Copy docs files.
+        const docsDir = locale === i18n.defaultLocale
+            ? path_1.default.resolve(siteDir, docsPath)
+            : (0, versions_1.getDocsDirPathLocalized)({
+                siteDir,
+                locale,
+                pluginId,
+                versionName: constants_1.CURRENT_VERSION_NAME,
+            });
+        if (!(await fs_extra_1.default.pathExists(docsDir)) ||
+            (await fs_extra_1.default.readdir(docsDir)).length === 0) {
+            if (locale === i18n.defaultLocale) {
+                throw new Error(logger_1.default.interpolate `${pluginIdLogPrefix}: no docs found in path=${docsDir}.`);
+            }
+            else {
+                logger_1.default.warn `${pluginIdLogPrefix}: no docs found in path=${docsDir}. Skipping.`;
+                return;
+            }
+        }
+        const newVersionDir = locale === i18n.defaultLocale
+            ? path_1.default.join((0, versions_1.getVersionedDocsDirPath)(siteDir, pluginId), `version-${version}`)
+            : (0, versions_1.getDocsDirPathLocalized)({
+                siteDir,
+                locale,
+                pluginId,
+                versionName: version,
+            });
+        await fs_extra_1.default.copy(docsDir, newVersionDir);
+    }));
     await createVersionedSidebarFile({
         siteDir,
         pluginId,

package/lib/index.js

@@ -27,7 +27,7 @@ const categoryGeneratedIndex_1 = require("./categoryGeneratedIndex");
 async function pluginContentDocs(context, options) {
     const { siteDir, generatedFilesDir, baseUrl, siteConfig } = context;
     const versionsMetadata = await (0, versions_1.readVersionsMetadata)({ context, options });
-    const pluginId = options.id ?? utils_1.DEFAULT_PLUGIN_ID;
+    const pluginId = options.id;
     const pluginDataDirRoot = path_1.default.join(generatedFilesDir, 'docusaurus-plugin-content-docs');
     const dataDir = path_1.default.join(pluginDataDirRoot, pluginId);
     const aliasedSource = (source) => `~docs/${(0, utils_1.posixPath)(path_1.default.relative(pluginDataDirRoot, source))}`;
@@ -48,12 +48,7 @@ async function pluginContentDocs(context, options) {
                 .arguments('<version>')
                 .description(commandDescription)
                 .action((version) => {
-                (0, cli_1.cliDocsVersionCommand)(version, siteDir, pluginId, {
-                    path: options.path,
-                    sidebarPath: options.sidebarPath,
-                    sidebarCollapsed: options.sidebarCollapsed,
-                    sidebarCollapsible: options.sidebarCollapsible,
-                });
+                (0, cli_1.cliDocsVersionCommand)(version, options, context);
             });
         },
         getTranslationFiles({ content }) {
@@ -138,12 +133,12 @@ async function pluginContentDocs(context, options) {
                 // TODO tags should be a sub route of the version route
                 async function createTagsListPage() {
                     const tagsProp = Object.values(versionTags).map((tagValue) => ({
-                        name: tagValue.label,
+                        label: tagValue.label,
                         permalink: tagValue.permalink,
                         count: tagValue.docIds.length,
                     }));
                     // Only create /tags page if there are tags.
-                    if (Object.keys(tagsProp).length > 0) {
+                    if (tagsProp.length > 0) {
                         const tagsPropPath = await createData(`${(0, utils_1.docuHash)(`tags-list-${version.versionName}-prop`)}.json`, JSON.stringify(tagsProp, null, 2));
                         addRoute({
                             path: version.tagsPath,

package/lib/props.d.ts

@@ -11,5 +11,5 @@ export declare function toVersionMetadataProp(pluginId: string, loadedVersion: L
 export declare function toTagDocListProp({ allTagsPath, tag, docs, }: {
     allTagsPath: string;
     tag: VersionTag;
-    docs: Pick<DocMetadata, 'id' | 'title' | 'description' | 'permalink'>[];
+    docs: DocMetadata[];
 }): PropTagDocList;

package/lib/props.js

@@ -104,10 +104,11 @@ function toTagDocListProp({ allTagsPath, tag, docs, }) {
         }));
     }
     return {
-        name: tag.label,
+        label: tag.label,
         permalink: tag.permalink,
-        docs: toDocListProp(),
         allTagsPath,
+        count: tag.docIds.length,
+        items: toDocListProp(),
     };
 }
 exports.toTagDocListProp = toTagDocListProp;

package/lib/types.d.ts

@@ -5,8 +5,9 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { Sidebars } from './sidebars/types';
-import type { BrokenMarkdownLink, Tag } from '@docusaurus/utils';
+import type { BrokenMarkdownLink } from '@docusaurus/utils';
 import type { VersionMetadata, LastUpdateData, DocMetadata, CategoryGeneratedIndexMetadata } from '@docusaurus/plugin-content-docs';
+import type { Tag } from '@docusaurus/types';
 export declare type DocFile = {
     contentPath: string;
     filePath: string;
@@ -22,7 +23,7 @@ export declare type VersionTag = Tag & {
     docIds: string[];
 };
 export declare type VersionTags = {
-    [key: string]: VersionTag;
+    [permalink: string]: VersionTag;
 };
 export declare type LoadedVersion = VersionMetadata & {
     mainDocId: string;

package/lib/versions.d.ts

@@ -11,6 +11,12 @@ export declare function getVersionedSidebarsDirPath(siteDir: string, pluginId: s
 export declare function getVersionsFilePath(siteDir: string, pluginId: string): string;
 export declare function readVersionsFile(siteDir: string, pluginId: string): Promise<string[] | null>;
 export declare function readVersionNames(siteDir: string, options: Pick<PluginOptions, 'id' | 'disableVersioning' | 'includeCurrentVersion'>): Promise<string[]>;
+export declare function getDocsDirPathLocalized({ siteDir, locale, pluginId, versionName, }: {
+    siteDir: string;
+    locale: string;
+    pluginId: string;
+    versionName: string;
+}): string;
 export declare function getDefaultVersionBanner({ versionName, versionNames, lastVersionName, }: {
     versionName: string;
     versionNames: string[];

package/lib/versions.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.readVersionsMetadata = exports.filterVersions = exports.getVersionBadge = exports.getVersionBanner = exports.getDefaultVersionBanner = exports.readVersionNames = exports.readVersionsFile = exports.getVersionsFilePath = exports.getVersionedSidebarsDirPath = exports.getVersionedDocsDirPath = void 0;
+exports.readVersionsMetadata = exports.filterVersions = exports.getVersionBadge = exports.getVersionBanner = exports.getDefaultVersionBanner = exports.getDocsDirPathLocalized = exports.readVersionNames = exports.readVersionsFile = exports.getVersionsFilePath = exports.getVersionedSidebarsDirPath = exports.getVersionedDocsDirPath = void 0;
 const tslib_1 = require("tslib");
 const path_1 = tslib_1.__importDefault(require("path"));
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
@@ -89,6 +89,7 @@ function getDocsDirPathLocalized({ siteDir, locale, pluginId, versionName, }) {
         ],
     });
 }
+exports.getDocsDirPathLocalized = getDocsDirPathLocalized;
 function getVersionMetadataPaths({ versionName, context, options, }) {
     const isCurrentVersion = versionName === constants_1.CURRENT_VERSION_NAME;
     const contentPathLocalized = getDocsDirPathLocalized({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "0.0.0-4837",
+  "version": "0.0.0-4840",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "exports": {
@@ -23,11 +23,11 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4837",
-    "@docusaurus/logger": "0.0.0-4837",
-    "@docusaurus/mdx-loader": "0.0.0-4837",
-    "@docusaurus/utils": "0.0.0-4837",
-    "@docusaurus/utils-validation": "0.0.0-4837",
+    "@docusaurus/core": "0.0.0-4840",
+    "@docusaurus/logger": "0.0.0-4840",
+    "@docusaurus/mdx-loader": "0.0.0-4840",
+    "@docusaurus/utils": "0.0.0-4840",
+    "@docusaurus/utils-validation": "0.0.0-4840",
     "combine-promises": "^1.1.0",
     "fs-extra": "^10.0.1",
     "import-fresh": "^3.3.0",
@@ -39,8 +39,8 @@
     "webpack": "^5.70.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4837",
-    "@docusaurus/types": "0.0.0-4837",
+    "@docusaurus/module-type-aliases": "0.0.0-4840",
+    "@docusaurus/types": "0.0.0-4840",
     "@types/js-yaml": "^4.0.5",
     "@types/picomatch": "^2.3.0",
     "commander": "^5.1.0",
@@ -56,5 +56,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "475b73ed768e51837beba5fb7bb3885716120e9a"
+  "gitHead": "31e83775c132dee13950e08b0cb9c936c13f80d5"
 }

package/src/cli.ts

@@ -9,16 +9,16 @@ import {
   getVersionsFilePath,
   getVersionedDocsDirPath,
   getVersionedSidebarsDirPath,
+  getDocsDirPathLocalized,
 } from './versions';
 import fs from 'fs-extra';
 import path from 'path';
-import type {
-  PathOptions,
-  SidebarOptions,
-} from '@docusaurus/plugin-content-docs';
+import type {PluginOptions} from '@docusaurus/plugin-content-docs';
 import {loadSidebarsFileUnsafe, resolveSidebarPathOption} from './sidebars';
+import {CURRENT_VERSION_NAME} from './constants';
 import {DEFAULT_PLUGIN_ID} from '@docusaurus/utils';
 import logger from '@docusaurus/logger';
+import type {LoadContext} from '@docusaurus/types';
 
 async function createVersionedSidebarFile({
   siteDir,
@@ -58,9 +58,8 @@ async function createVersionedSidebarFile({
 // Tests depend on non-default export for mocking.
 export async function cliDocsVersionCommand(
   version: string | null | undefined,
-  siteDir: string,
-  pluginId: string,
-  options: PathOptions & SidebarOptions,
+  {id: pluginId, path: docsPath, sidebarPath}: PluginOptions,
+  {siteDir, i18n}: LoadContext,
 ): Promise<void> {
   // It wouldn't be very user-friendly to show a [default] log prefix,
   // so we use [docs] instead of [default]
@@ -114,22 +113,53 @@ export async function cliDocsVersionCommand(
     );
   }
 
-  const {path: docsPath, sidebarPath} = options;
-
-  // Copy docs files.
-  const docsDir = path.resolve(siteDir, docsPath);
-
-  if (
-    (await fs.pathExists(docsDir)) &&
-    (await fs.readdir(docsDir)).length > 0
-  ) {
-    const versionedDir = getVersionedDocsDirPath(siteDir, pluginId);
-    const newVersionDir = path.join(versionedDir, `version-${version}`);
-    await fs.copy(docsDir, newVersionDir);
-  } else {
-    throw new Error(`${pluginIdLogPrefix}: no docs found in ${docsDir}.`);
+  if (i18n.locales.length > 1) {
+    logger.info`Versioned docs will be created for the following locales: name=${i18n.locales}`;
   }
 
+  await Promise.all(
+    i18n.locales.map(async (locale) => {
+      // Copy docs files.
+      const docsDir =
+        locale === i18n.defaultLocale
+          ? path.resolve(siteDir, docsPath)
+          : getDocsDirPathLocalized({
+              siteDir,
+              locale,
+              pluginId,
+              versionName: CURRENT_VERSION_NAME,
+            });
+
+      if (
+        !(await fs.pathExists(docsDir)) ||
+        (await fs.readdir(docsDir)).length === 0
+      ) {
+        if (locale === i18n.defaultLocale) {
+          throw new Error(
+            logger.interpolate`${pluginIdLogPrefix}: no docs found in path=${docsDir}.`,
+          );
+        } else {
+          logger.warn`${pluginIdLogPrefix}: no docs found in path=${docsDir}. Skipping.`;
+          return;
+        }
+      }
+
+      const newVersionDir =
+        locale === i18n.defaultLocale
+          ? path.join(
+              getVersionedDocsDirPath(siteDir, pluginId),
+              `version-${version}`,
+            )
+          : getDocsDirPathLocalized({
+              siteDir,
+              locale,
+              pluginId,
+              versionName: version,
+            });
+      await fs.copy(docsDir, newVersionDir);
+    }),
+  );
+
   await createVersionedSidebarFile({
     siteDir,
     pluginId,

package/src/index.ts

@@ -67,7 +67,7 @@ export default async function pluginContentDocs(
 
   const versionsMetadata = await readVersionsMetadata({context, options});
 
-  const pluginId = options.id ?? DEFAULT_PLUGIN_ID;
+  const pluginId = options.id;
 
   const pluginDataDirRoot = path.join(
     generatedFilesDir,
@@ -97,12 +97,7 @@ export default async function pluginContentDocs(
         .arguments('<version>')
         .description(commandDescription)
         .action((version) => {
-          cliDocsVersionCommand(version, siteDir, pluginId, {
-            path: options.path,
-            sidebarPath: options.sidebarPath,
-            sidebarCollapsed: options.sidebarCollapsed,
-            sidebarCollapsible: options.sidebarCollapsible,
-          });
+          cliDocsVersionCommand(version, options, context);
         });
     },
 
@@ -228,13 +223,13 @@ export default async function pluginContentDocs(
           const tagsProp: PropTagsListPage['tags'] = Object.values(
             versionTags,
           ).map((tagValue) => ({
-            name: tagValue.label,
+            label: tagValue.label,
             permalink: tagValue.permalink,
             count: tagValue.docIds.length,
           }));
 
           // Only create /tags page if there are tags.
-          if (Object.keys(tagsProp).length > 0) {
+          if (tagsProp.length > 0) {
             const tagsPropPath = await createData(
               `${docuHash(`tags-list-${version.versionName}-prop`)}.json`,
               JSON.stringify(tagsProp, null, 2),

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

@@ -7,7 +7,8 @@
 
 declare module '@docusaurus/plugin-content-docs' {
   import type {MDXOptions} from '@docusaurus/mdx-loader';
-  import type {ContentPaths, Tag, FrontMatterTag} from '@docusaurus/utils';
+  import type {ContentPaths, FrontMatterTag} from '@docusaurus/utils';
+  import type {TagsListItem, TagModule, Tag} from '@docusaurus/types';
   import type {Required} from 'utility-types';
 
   export type Assets = {
@@ -483,25 +484,14 @@ declare module '@docusaurus/plugin-content-docs' {
   export type PropSidebar = import('./sidebars/types').PropSidebar;
   export type PropSidebars = import('./sidebars/types').PropSidebars;
 
-  export type PropTagDocListDoc = {
-    id: string;
-    title: string;
-    description: string;
-    permalink: string;
-  };
-  export type PropTagDocList = {
-    allTagsPath: string;
-    name: string; // normalized name/label of the tag
-    permalink: string; // pathname of the tag
-    docs: PropTagDocListDoc[];
-  };
+  export type PropTagDocListDoc = Pick<
+    DocMetadata,
+    'id' | 'title' | 'description' | 'permalink'
+  >;
+  export type PropTagDocList = TagModule & {items: PropTagDocListDoc[]};
 
   export type PropTagsListPage = {
-    tags: {
-      name: string;
-      permalink: string;
-      count: number;
-    }[];
+    tags: TagsListItem[];
   };
 }
 

package/src/props.ts

@@ -137,7 +137,7 @@ export function toTagDocListProp({
 }: {
   allTagsPath: string;
   tag: VersionTag;
-  docs: Pick<DocMetadata, 'id' | 'title' | 'description' | 'permalink'>[];
+  docs: DocMetadata[];
 }): PropTagDocList {
   function toDocListProp(): PropTagDocListDoc[] {
     const list = _.compact(
@@ -154,9 +154,10 @@ export function toTagDocListProp({
   }
 
   return {
-    name: tag.label,
+    label: tag.label,
     permalink: tag.permalink,
-    docs: toDocListProp(),
     allTagsPath,
+    count: tag.docIds.length,
+    items: toDocListProp(),
   };
 }

package/src/types.ts

@@ -8,13 +8,14 @@
 /// <reference types="@docusaurus/module-type-aliases" />
 
 import type {Sidebars} from './sidebars/types';
-import type {BrokenMarkdownLink, Tag} from '@docusaurus/utils';
+import type {BrokenMarkdownLink} from '@docusaurus/utils';
 import type {
   VersionMetadata,
   LastUpdateData,
   DocMetadata,
   CategoryGeneratedIndexMetadata,
 } from '@docusaurus/plugin-content-docs';
+import type {Tag} from '@docusaurus/types';
 
 export type DocFile = {
   contentPath: string; // /!\ may be localized
@@ -33,7 +34,7 @@ export type VersionTag = Tag & {
   docIds: string[];
 };
 export type VersionTags = {
-  [key: string]: VersionTag;
+  [permalink: string]: VersionTag;
 };
 
 export type LoadedVersion = VersionMetadata & {

package/src/versions.ts

@@ -133,7 +133,7 @@ export async function readVersionNames(
   return versions;
 }
 
-function getDocsDirPathLocalized({
+export function getDocsDirPathLocalized({
   siteDir,
   locale,
   pluginId,
@@ -143,7 +143,7 @@ function getDocsDirPathLocalized({
   locale: string;
   pluginId: string;
   versionName: string;
-}) {
+}): string {
   return getPluginI18nPath({
     siteDir,
     locale,