@docusaurus/plugin-content-docs 0.0.0-4713 → 0.0.0-4717

package/lib/cli.js

@@ -46,7 +46,7 @@ async function cliDocsVersionCommand(version, siteDir, pluginId, options) {
     // Since we are going to create `version-${version}` folder, we need to make
     // sure it's a valid pathname.
     // eslint-disable-next-line no-control-regex
-    if (/[<>:"|?*\x00-\x1F]/g.test(version)) {
+    if (/[<>:"|?*\x00-\x1F]/.test(version)) {
         throw new Error(`${pluginIdLogPrefix}: invalid version tag specified! Please ensure its a valid pathname too. Try something like: 1.0.0.`);
     }
     if (/^\.\.?$/.test(version)) {

package/lib/numberPrefix.js

@@ -8,33 +8,28 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.stripPathNumberPrefixes = exports.stripNumberPrefix = exports.DisabledNumberPrefixParser = exports.DefaultNumberPrefixParser = void 0;
 // Best-effort to avoid parsing some patterns as number prefix
-const IgnoredPrefixPatterns = (() => {
-    // ignore common date-like patterns: https://github.com/facebook/docusaurus/issues/4640
-    const DateLikePrefixRegex = /^(?:\d{2}|\d{4})[-_.]\d{2}(?:[-_.](?:\d{2}|\d{4}))?.*$/;
-    // ignore common versioning patterns: https://github.com/facebook/docusaurus/issues/4653
-    // note: we could try to parse float numbers in filenames but that is
-    // probably not worth it as a version such as "8.0" can be interpreted as both
-    // a version and a float. User can configure her own NumberPrefixParser if
-    // she wants 8.0 to be interpreted as a float
-    const VersionLikePrefixRegex = /^\d+[-_.]\d+.*$/;
-    return new RegExp(`${DateLikePrefixRegex.source}|${VersionLikePrefixRegex.source}`);
-})();
-const NumberPrefixRegex = /^(?<numberPrefix>\d+)(?<separator>\s*[-_.]+\s*)(?<suffix>.*)$/;
+// ignore common date-like patterns: https://github.com/facebook/docusaurus/issues/4640
+// ignore common versioning patterns: https://github.com/facebook/docusaurus/issues/4653
+// Both of them would look like 7.0-foo or 2021-11-foo
+// note: we could try to parse float numbers in filenames, but that is probably
+// not worth it, as a version such as "8.0" can be interpreted as either a
+// version or a float. User can configure her own NumberPrefixParser if she
+// wants 8.0 to be interpreted as a float
+const ignoredPrefixPattern = /^\d+[-_.]\d+/;
+const numberPrefixPattern = /^(?<numberPrefix>\d+)\s*[-_.]+\s*(?<suffix>[^-_.\s].*)$/;
 // 0-myDoc => {filename: myDoc, numberPrefix: 0}
 // 003 - myDoc => {filename: myDoc, numberPrefix: 3}
 const DefaultNumberPrefixParser = (filename) => {
-    if (IgnoredPrefixPatterns.exec(filename)) {
+    if (ignoredPrefixPattern.test(filename)) {
+        return { filename, numberPrefix: undefined };
+    }
+    const match = numberPrefixPattern.exec(filename);
+    if (!match) {
         return { filename, numberPrefix: undefined };
     }
-    const match = NumberPrefixRegex.exec(filename);
-    const cleanFileName = match?.groups?.suffix ?? filename;
-    const numberPrefixString = match?.groups?.numberPrefix;
-    const numberPrefix = numberPrefixString
-        ? parseInt(numberPrefixString, 10)
-        : undefined;
     return {
-        filename: cleanFileName,
-        numberPrefix,
+        filename: match.groups.suffix,
+        numberPrefix: parseInt(match.groups.numberPrefix, 10),
     };
 };
 exports.DefaultNumberPrefixParser = DefaultNumberPrefixParser;

package/package.json

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

package/src/cli.ts

@@ -88,7 +88,7 @@ export async function cliDocsVersionCommand(
   // Since we are going to create `version-${version}` folder, we need to make
   // sure it's a valid pathname.
   // eslint-disable-next-line no-control-regex
-  if (/[<>:"|?*\x00-\x1F]/g.test(version)) {
+  if (/[<>:"|?*\x00-\x1F]/.test(version)) {
     throw new Error(
       `${pluginIdLogPrefix}: invalid version tag specified! Please ensure its a valid pathname too. Try something like: 1.0.0.`,
     );

package/src/numberPrefix.ts

@@ -8,43 +8,33 @@
 import type {NumberPrefixParser} from '@docusaurus/plugin-content-docs';
 
 // Best-effort to avoid parsing some patterns as number prefix
-const IgnoredPrefixPatterns = (() => {
-  // ignore common date-like patterns: https://github.com/facebook/docusaurus/issues/4640
-  const DateLikePrefixRegex =
-    /^(?:\d{2}|\d{4})[-_.]\d{2}(?:[-_.](?:\d{2}|\d{4}))?.*$/;
-
-  // ignore common versioning patterns: https://github.com/facebook/docusaurus/issues/4653
-  // note: we could try to parse float numbers in filenames but that is
-  // probably not worth it as a version such as "8.0" can be interpreted as both
-  // a version and a float. User can configure her own NumberPrefixParser if
-  // she wants 8.0 to be interpreted as a float
-  const VersionLikePrefixRegex = /^\d+[-_.]\d+.*$/;
-
-  return new RegExp(
-    `${DateLikePrefixRegex.source}|${VersionLikePrefixRegex.source}`,
-  );
-})();
-
-const NumberPrefixRegex =
-  /^(?<numberPrefix>\d+)(?<separator>\s*[-_.]+\s*)(?<suffix>.*)$/;
+// ignore common date-like patterns: https://github.com/facebook/docusaurus/issues/4640
+// ignore common versioning patterns: https://github.com/facebook/docusaurus/issues/4653
+// Both of them would look like 7.0-foo or 2021-11-foo
+// note: we could try to parse float numbers in filenames, but that is probably
+// not worth it, as a version such as "8.0" can be interpreted as either a
+// version or a float. User can configure her own NumberPrefixParser if she
+// wants 8.0 to be interpreted as a float
+const ignoredPrefixPattern = /^\d+[-_.]\d+/;
+
+const numberPrefixPattern =
+  /^(?<numberPrefix>\d+)\s*[-_.]+\s*(?<suffix>[^-_.\s].*)$/;
 
 // 0-myDoc => {filename: myDoc, numberPrefix: 0}
 // 003 - myDoc => {filename: myDoc, numberPrefix: 3}
 export const DefaultNumberPrefixParser: NumberPrefixParser = (
   filename: string,
 ) => {
-  if (IgnoredPrefixPatterns.exec(filename)) {
+  if (ignoredPrefixPattern.test(filename)) {
+    return {filename, numberPrefix: undefined};
+  }
+  const match = numberPrefixPattern.exec(filename);
+  if (!match) {
     return {filename, numberPrefix: undefined};
   }
-  const match = NumberPrefixRegex.exec(filename);
-  const cleanFileName = match?.groups?.suffix ?? filename;
-  const numberPrefixString = match?.groups?.numberPrefix;
-  const numberPrefix = numberPrefixString
-    ? parseInt(numberPrefixString, 10)
-    : undefined;
   return {
-    filename: cleanFileName,
-    numberPrefix,
+    filename: match.groups!.suffix!,
+    numberPrefix: parseInt(match.groups!.numberPrefix!, 10),
   };
 };