@docusaurus/plugin-content-docs 0.0.0-5047 → 0.0.0-5050

package/lib/cli.js

@@ -41,12 +41,7 @@ async function cliDocsVersionCommand(version, { id: pluginId, path: docsPath, si
         logger_1.default.info `${pluginIdLogPrefix}: Invalid version name provided. Try something like: 1.0.0`;
         throw err;
     }
-    // Load existing versions.
-    let versions = [];
-    const versionsJSONFile = (0, files_1.getVersionsFilePath)(siteDir, pluginId);
-    if (await fs_extra_1.default.pathExists(versionsJSONFile)) {
-        versions = await fs_extra_1.default.readJSON(versionsJSONFile);
-    }
+    const versions = (await (0, files_1.readVersionsFile)(siteDir, pluginId)) ?? [];
     // Check if version already exists.
     if (versions.includes(version)) {
         throw new Error(`${pluginIdLogPrefix}: this version already exists! Use a version tag that does not already exist.`);
@@ -92,7 +87,7 @@ async function cliDocsVersionCommand(version, { id: pluginId, path: docsPath, si
     });
     // Update versions.json file.
     versions.unshift(version);
-    await fs_extra_1.default.outputFile(versionsJSONFile, `${JSON.stringify(versions, null, 2)}\n`);
+    await fs_extra_1.default.outputFile((0, files_1.getVersionsFilePath)(siteDir, pluginId), `${JSON.stringify(versions, null, 2)}\n`);
     logger_1.default.success `name=${pluginIdLogPrefix}: version name=${version} created!`;
 }
 exports.cliDocsVersionCommand = cliDocsVersionCommand;

package/lib/sidebars/postProcessor.d.ts

@@ -5,4 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { Sidebars, SidebarProcessorParams, ProcessedSidebars } from './types';
+export declare type SidebarPostProcessorParams = SidebarProcessorParams & {
+    draftIds: Set<string>;
+};
 export declare function postProcessSidebars(sidebars: ProcessedSidebars, params: SidebarProcessorParams): Sidebars;

package/lib/versions/files.d.ts

@@ -18,6 +18,13 @@ export declare function getDocsDirPathLocalized({ siteDir, locale, pluginId, ver
 }): string;
 /** `community` => `[siteDir]/community_versions.json` */
 export declare function getVersionsFilePath(siteDir: string, pluginId: string): string;
+/**
+ * Reads the plugin's respective `versions.json` file, and returns its content.
+ *
+ * @throws Throws if validation fails, i.e. `versions.json` doesn't contain an
+ * array of valid version names.
+ */
+export declare function readVersionsFile(siteDir: string, pluginId: string): Promise<string[] | null>;
 /**
  * Reads the `versions.json` file, and returns an ordered list of version names.
  *

package/lib/versions/files.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getVersionMetadataPaths = exports.readVersionNames = exports.getVersionsFilePath = exports.getDocsDirPathLocalized = exports.getVersionSidebarsPath = exports.getVersionDocsDirPath = void 0;
+exports.getVersionMetadataPaths = exports.readVersionNames = exports.readVersionsFile = exports.getVersionsFilePath = exports.getDocsDirPathLocalized = exports.getVersionSidebarsPath = exports.getVersionDocsDirPath = 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"));
@@ -63,6 +63,7 @@ async function readVersionsFile(siteDir, pluginId) {
     }
     return null;
 }
+exports.readVersionsFile = readVersionsFile;
 /**
  * Reads the `versions.json` file, and returns an ordered list of version names.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "0.0.0-5047",
+  "version": "0.0.0-5050",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "sideEffects": false,
@@ -25,11 +25,11 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-5047",
-    "@docusaurus/logger": "0.0.0-5047",
-    "@docusaurus/mdx-loader": "0.0.0-5047",
-    "@docusaurus/utils": "0.0.0-5047",
-    "@docusaurus/utils-validation": "0.0.0-5047",
+    "@docusaurus/core": "0.0.0-5050",
+    "@docusaurus/logger": "0.0.0-5050",
+    "@docusaurus/mdx-loader": "0.0.0-5050",
+    "@docusaurus/utils": "0.0.0-5050",
+    "@docusaurus/utils-validation": "0.0.0-5050",
     "combine-promises": "^1.1.0",
     "fs-extra": "^10.1.0",
     "import-fresh": "^3.3.0",
@@ -41,8 +41,8 @@
     "webpack": "^5.72.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-5047",
-    "@docusaurus/types": "0.0.0-5047",
+    "@docusaurus/module-type-aliases": "0.0.0-5050",
+    "@docusaurus/types": "0.0.0-5050",
     "@types/js-yaml": "^4.0.5",
     "@types/picomatch": "^2.3.0",
     "commander": "^5.1.0",
@@ -58,5 +58,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "67ac297469d98ac3eb8482d8636aee4648586f33"
+  "gitHead": "1e14a127a30082891b24582362a69bca2f8d4b0d"
 }

package/src/cli.ts

@@ -14,6 +14,7 @@ import {
   getVersionDocsDirPath,
   getVersionSidebarsPath,
   getDocsDirPathLocalized,
+  readVersionsFile,
 } from './versions/files';
 import {validateVersionName} from './versions/validation';
 import {loadSidebarsFileUnsafe} from './sidebars';
@@ -69,12 +70,7 @@ export async function cliDocsVersionCommand(
     throw err;
   }
 
-  // Load existing versions.
-  let versions: string[] = [];
-  const versionsJSONFile = getVersionsFilePath(siteDir, pluginId);
-  if (await fs.pathExists(versionsJSONFile)) {
-    versions = await fs.readJSON(versionsJSONFile);
-  }
+  const versions = (await readVersionsFile(siteDir, pluginId)) ?? [];
 
   // Check if version already exists.
   if (versions.includes(version)) {
@@ -137,7 +133,7 @@ export async function cliDocsVersionCommand(
   // Update versions.json file.
   versions.unshift(version);
   await fs.outputFile(
-    versionsJSONFile,
+    getVersionsFilePath(siteDir, pluginId),
     `${JSON.stringify(versions, null, 2)}\n`,
   );
 

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

@@ -17,7 +17,7 @@ declare module '@docusaurus/plugin-content-docs' {
     Tag,
   } from '@docusaurus/utils';
   import type {Plugin, LoadContext} from '@docusaurus/types';
-  import type {Required} from 'utility-types';
+  import type {Overwrite, Required} from 'utility-types';
 
   export type Assets = {
     image?: string;
@@ -206,7 +206,22 @@ declare module '@docusaurus/plugin-content-docs' {
        */
       tagsBasePath: string;
     };
-  export type Options = Partial<PluginOptions>;
+  export type Options = Partial<
+    Overwrite<
+      PluginOptions,
+      {
+        /**
+         * Custom parsing logic to extract number prefixes from file names. Use
+         * `false` to disable this behavior and leave the docs untouched, and
+         * `true` to use the default parser.
+         *
+         * @param filename One segment of the path, without any slashes.
+         * @see https://docusaurus.io/docs/sidebar#using-number-prefixes
+         */
+        numberPrefixParser: PluginOptions['numberPrefixParser'] | boolean;
+      }
+    >
+  >;
   export type SidebarsConfig = import('./sidebars/types').SidebarsConfig;
 
   export type VersionMetadata = ContentPaths & {

package/src/sidebars/postProcessor.ts

@@ -18,7 +18,7 @@ import type {
   SidebarItemCategoryLink,
 } from './types';
 
-type SidebarPostProcessorParams = SidebarProcessorParams & {
+export type SidebarPostProcessorParams = SidebarProcessorParams & {
   draftIds: Set<string>;
 };
 

package/src/versions/files.ts

@@ -89,7 +89,7 @@ export function getVersionsFilePath(siteDir: string, pluginId: string): string {
  * @throws Throws if validation fails, i.e. `versions.json` doesn't contain an
  * array of valid version names.
  */
-async function readVersionsFile(
+export async function readVersionsFile(
   siteDir: string,
   pluginId: string,
 ): Promise<string[] | null> {