@docusaurus/plugin-content-docs 2.0.0-beta.0e652730d → 2.0.0-beta.10

package/lib/versions.js

@@ -8,16 +8,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getDocsDirPaths = exports.readVersionsMetadata = 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"));
+const path_1 = (0, tslib_1.__importDefault)(require("path"));
+const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
 const constants_1 = require("./constants");
-const constants_2 = require("@docusaurus/core/lib/constants");
 const utils_1 = require("@docusaurus/utils");
 const lodash_1 = require("lodash");
 const sidebars_1 = require("./sidebars");
 // retro-compatibility: no prefix for the default plugin id
 function addPluginIdPrefix(fileOrDir, pluginId) {
-    if (pluginId === constants_2.DEFAULT_PLUGIN_ID) {
+    if (pluginId === utils_1.DEFAULT_PLUGIN_ID) {
         return fileOrDir;
     }
     else {
@@ -83,7 +82,7 @@ function readVersionNames(siteDir, options) {
     return versions;
 }
 function getDocsDirPathLocalized({ siteDir, locale, pluginId, versionName, }) {
-    return utils_1.getPluginI18nPath({
+    return (0, utils_1.getPluginI18nPath)({
         siteDir,
         locale,
         pluginName: 'docusaurus-plugin-content-docs',
@@ -108,7 +107,7 @@ function getVersionMetadataPaths({ versionName, context, options, }) {
     });
     function getSidebarFilePath() {
         if (isCurrentVersion) {
-            return sidebars_1.resolveSidebarPathOption(context.siteDir, options.sidebarPath);
+            return (0, sidebars_1.resolveSidebarPathOption)(context.siteDir, options.sidebarPath);
         }
         else {
             return path_1.default.join(getVersionedSidebarsDirPath(context.siteDir, options.id), `version-${versionName}-sidebars.json`);
@@ -138,10 +137,10 @@ function getVersionEditUrls({ contentPath, contentPathLocalized, context: { site
             pluginId: id,
         })
         : contentPathLocalized;
-    const versionPathSegment = utils_1.posixPath(path_1.default.relative(siteDir, path_1.default.resolve(siteDir, editDirPath)));
-    const versionPathSegmentLocalized = utils_1.posixPath(path_1.default.relative(siteDir, path_1.default.resolve(siteDir, editDirPathLocalized)));
-    const versionEditUrl = utils_1.normalizeUrl([editUrl, versionPathSegment]);
-    const versionEditUrlLocalized = utils_1.normalizeUrl([
+    const versionPathSegment = (0, utils_1.posixPath)(path_1.default.relative(siteDir, path_1.default.resolve(siteDir, editDirPath)));
+    const versionPathSegmentLocalized = (0, utils_1.posixPath)(path_1.default.relative(siteDir, path_1.default.resolve(siteDir, editDirPathLocalized)));
+    const versionEditUrl = (0, utils_1.normalizeUrl)([editUrl, versionPathSegment]);
+    const versionEditUrlLocalized = (0, utils_1.normalizeUrl)([
         editUrl,
         versionPathSegmentLocalized,
     ]);
@@ -150,24 +149,64 @@ function getVersionEditUrls({ contentPath, contentPathLocalized, context: { site
         versionEditUrlLocalized,
     };
 }
-function createVersionMetadata({ versionName, isLast, context, options, }) {
-    var _a, _b, _c;
-    const { sidebarFilePath, contentPath, contentPathLocalized, } = getVersionMetadataPaths({
+function getDefaultVersionBanner({ versionName, versionNames, lastVersionName, }) {
+    // Current version: good, no banner
+    if (versionName === lastVersionName) {
+        return null;
+    }
+    // Upcoming versions: unreleased banner
+    else if (versionNames.indexOf(versionName) < versionNames.indexOf(lastVersionName)) {
+        return 'unreleased';
+    }
+    // Older versions: display unmaintained banner
+    else {
+        return 'unmaintained';
+    }
+}
+function getVersionBanner({ versionName, versionNames, lastVersionName, options, }) {
+    var _a;
+    const versionBannerOption = (_a = options.versions[versionName]) === null || _a === void 0 ? void 0 : _a.banner;
+    if (versionBannerOption) {
+        return versionBannerOption === 'none' ? null : versionBannerOption;
+    }
+    return getDefaultVersionBanner({
         versionName,
-        context,
-        options,
+        versionNames,
+        lastVersionName,
     });
+}
+function getVersionBadge({ versionName, versionNames, options, }) {
+    var _a;
+    const versionBadgeOption = (_a = options.versions[versionName]) === null || _a === void 0 ? void 0 : _a.badge;
+    // If site is not versioned or only one version is included
+    // we don't show the version badge by default
+    // See https://github.com/facebook/docusaurus/issues/3362
+    const versionBadgeDefault = versionNames.length !== 1;
+    return versionBadgeOption !== null && versionBadgeOption !== void 0 ? versionBadgeOption : versionBadgeDefault;
+}
+function getVersionClassName({ versionName, options, }) {
+    var _a;
+    const versionClassNameOption = (_a = options.versions[versionName]) === null || _a === void 0 ? void 0 : _a.className;
+    const versionClassNameDefault = `docs-version-${versionName}`;
+    return versionClassNameOption !== null && versionClassNameOption !== void 0 ? versionClassNameOption : versionClassNameDefault;
+}
+function createVersionMetadata({ versionName, versionNames, lastVersionName, context, options, }) {
+    var _a, _b, _c;
+    const { sidebarFilePath, contentPath, contentPathLocalized } = getVersionMetadataPaths({ versionName, context, options });
+    const isLast = versionName === lastVersionName;
     // retro-compatible values
     const defaultVersionLabel = versionName === constants_1.CURRENT_VERSION_NAME ? 'Next' : versionName;
-    const defaultVersionPathPart = isLast
-        ? ''
-        : versionName === constants_1.CURRENT_VERSION_NAME
-            ? 'next'
-            : versionName;
+    function getDefaultVersionPathPart() {
+        if (isLast) {
+            return '';
+        }
+        return versionName === constants_1.CURRENT_VERSION_NAME ? 'next' : versionName;
+    }
+    const defaultVersionPathPart = getDefaultVersionPathPart();
     const versionOptions = (_a = options.versions[versionName]) !== null && _a !== void 0 ? _a : {};
     const versionLabel = (_b = versionOptions.label) !== null && _b !== void 0 ? _b : defaultVersionLabel;
     const versionPathPart = (_c = versionOptions.path) !== null && _c !== void 0 ? _c : defaultVersionPathPart;
-    const versionPath = utils_1.normalizeUrl([
+    const versionPath = (0, utils_1.normalizeUrl)([
         context.baseUrl,
         options.routeBasePath,
         versionPathPart,
@@ -180,12 +219,24 @@ function createVersionMetadata({ versionName, isLast, context, options, }) {
     });
     // Because /docs/:route` should always be after `/docs/versionName/:route`.
     const routePriority = versionPathPart === '' ? -1 : undefined;
+    // the path that will be used to refer the docs tags
+    // example below will be using /docs/tags
+    const tagsPath = (0, utils_1.normalizeUrl)([versionPath, options.tagsBasePath]);
     return {
         versionName,
         versionLabel,
         versionPath,
+        tagsPath,
         versionEditUrl: versionEditUrls === null || versionEditUrls === void 0 ? void 0 : versionEditUrls.versionEditUrl,
         versionEditUrlLocalized: versionEditUrls === null || versionEditUrls === void 0 ? void 0 : versionEditUrls.versionEditUrlLocalized,
+        versionBanner: getVersionBanner({
+            versionName,
+            versionNames,
+            lastVersionName,
+            options,
+        }),
+        versionBadge: getVersionBadge({ versionName, versionNames, options }),
+        versionClassName: getVersionClassName({ versionName, options }),
         isLast,
         routePriority,
         sidebarFilePath,
@@ -231,7 +282,7 @@ function checkVersionsOptions(availableVersionNames, options) {
         !availableVersionNames.includes(options.lastVersion)) {
         throw new Error(`Docs option lastVersion=${options.lastVersion} is invalid. ${availableVersionNamesMsg}`);
     }
-    const unknownVersionConfigNames = lodash_1.difference(Object.keys(options.versions), availableVersionNames);
+    const unknownVersionConfigNames = (0, lodash_1.difference)(Object.keys(options.versions), availableVersionNames);
     if (unknownVersionConfigNames.length > 0) {
         throw new Error(`Invalid docs option "versions": unknown versions (${unknownVersionConfigNames.join(',')}) found. ${availableVersionNamesMsg}`);
     }
@@ -239,7 +290,7 @@ function checkVersionsOptions(availableVersionNames, options) {
         if (options.onlyIncludeVersions.length === 0) {
             throw new Error(`Invalid docs option "onlyIncludeVersions": an empty array is not allowed, at least one version is needed.`);
         }
-        const unknownOnlyIncludeVersionNames = lodash_1.difference(options.onlyIncludeVersions, availableVersionNames);
+        const unknownOnlyIncludeVersionNames = (0, lodash_1.difference)(options.onlyIncludeVersions, availableVersionNames);
         if (unknownOnlyIncludeVersionNames.length > 0) {
             throw new Error(`Invalid docs option "onlyIncludeVersions": unknown versions (${unknownOnlyIncludeVersionNames.join(',')}) found. ${availableVersionNamesMsg}`);
         }
@@ -269,7 +320,8 @@ function readVersionsMetadata({ context, options, }) {
     const lastVersionName = (_a = options.lastVersion) !== null && _a !== void 0 ? _a : getDefaultLastVersionName(versionNames);
     const versionsMetadata = versionNames.map((versionName) => createVersionMetadata({
         versionName,
-        isLast: versionName === lastVersionName,
+        versionNames,
+        lastVersionName,
         context,
         options,
     }));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "2.0.0-beta.0e652730d",
+  "version": "2.0.0-beta.10",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-docs.d.ts",
@@ -17,40 +17,42 @@
     "directory": "packages/docusaurus-plugin-content-docs"
   },
   "license": "MIT",
-  "devDependencies": {
-    "@docusaurus/module-type-aliases": "2.0.0-beta.0e652730d",
-    "@types/js-yaml": "^4.0.0",
-    "@types/picomatch": "^2.2.1",
-    "commander": "^5.1.0",
-    "picomatch": "^2.1.1"
-  },
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.0e652730d",
-    "@docusaurus/mdx-loader": "2.0.0-beta.0e652730d",
-    "@docusaurus/types": "2.0.0-beta.0e652730d",
-    "@docusaurus/utils": "2.0.0-beta.0e652730d",
-    "@docusaurus/utils-validation": "2.0.0-beta.0e652730d",
-    "chalk": "^4.1.1",
+    "@docusaurus/mdx-loader": "2.0.0-beta.10",
+    "@docusaurus/utils": "2.0.0-beta.10",
+    "@docusaurus/utils-validation": "2.0.0-beta.10",
+    "chalk": "^4.1.2",
     "combine-promises": "^1.1.0",
-    "execa": "^5.0.0",
+    "escape-string-regexp": "^4.0.0",
     "fs-extra": "^10.0.0",
     "globby": "^11.0.2",
     "import-fresh": "^3.2.2",
     "js-yaml": "^4.0.0",
-    "loader-utils": "^1.2.3",
+    "loader-utils": "^2.0.0",
     "lodash": "^4.17.20",
     "remark-admonitions": "^1.2.1",
     "shelljs": "^0.8.4",
-    "tslib": "^2.2.0",
+    "tslib": "^2.3.1",
     "utility-types": "^3.10.0",
-    "webpack": "^5.37.0"
+    "webpack": "^5.61.0"
+  },
+  "devDependencies": {
+    "@docusaurus/core": "2.0.0-beta.10",
+    "@docusaurus/module-type-aliases": "2.0.0-beta.10",
+    "@docusaurus/types": "2.0.0-beta.10",
+    "@types/js-yaml": "^4.0.0",
+    "@types/picomatch": "^2.2.1",
+    "commander": "^5.1.0",
+    "picomatch": "^2.1.1",
+    "utility-types": "^3.10.0"
   },
   "peerDependencies": {
+    "@docusaurus/core": "2.0.0-beta.9",
     "react": "^16.8.4 || ^17.0.0",
     "react-dom": "^16.8.4 || ^17.0.0"
   },
   "engines": {
-    "node": ">=12.13.0"
+    "node": ">=14"
   },
-  "gitHead": "295893e14eedbbfad2eefb39ec5219404547fc31"
+  "gitHead": "6f4869af5721435d6995e63e2f24ac41646e34ea"
 }

package/src/__tests__/__fixtures__/simple-site/docs/_partials/somePartial.md

@@ -0,0 +1,3 @@
+This is a partial in file/folder starting with _:
+
+It should be excluded by default

package/src/__tests__/__fixtures__/simple-site/docs/_partials/subfolder/somePartial.md

@@ -0,0 +1,3 @@
+This is a partial in file/folder starting with _:
+
+It should be excluded by default

package/src/__tests__/__fixtures__/simple-site/docs/_somePartial.md

@@ -0,0 +1,3 @@
+This is a partial in file/folder starting with \_:
+
+It should be excluded by default

package/src/__tests__/__fixtures__/simple-site/docs/foo/baz.md

@@ -3,6 +3,11 @@ id: baz
 title: baz
 slug: bazSlug.html
 pagination_label: baz pagination_label
+tags:
+  - tag 1
+  - tag-1
+  - label: tag 2
+    permalink: tag2-custom-permalink
 ---
 
 # Baz markdown title

package/src/__tests__/__fixtures__/simple-site/docs/hello.md

@@ -2,6 +2,8 @@
 id: hello
 title: Hello, World !
 sidebar_label: Hello sidebar_label
+tags: [tag-1, tag 3]
+slug: /
 ---
 
 Hi, Endilie here :)

package/src/__tests__/__fixtures__/simple-site/docs/rootAbsoluteSlug.md

@@ -1,5 +1,7 @@
 ---
 slug: /rootAbsoluteSlug
+pagination_next: headingAsTitle
+pagination_prev: foo/baz
 ---
 
 Lorem

package/src/__tests__/__fixtures__/simple-site/docs/rootRelativeSlug.md

@@ -1,5 +1,7 @@
 ---
 slug: rootRelativeSlug
+pagination_next: headingAsTitle
+pagination_prev: foo/baz
 ---
 
 Lorem

package/src/__tests__/__fixtures__/simple-site/docs/rootResolvedSlug.md

@@ -1,5 +1,7 @@
 ---
 slug: ./hey/ho/../rootResolvedSlug
+pagination_next: headingAsTitle
+pagination_prev: foo/baz
 ---
 
 Lorem

package/src/__tests__/__fixtures__/simple-site/docs/rootTryToEscapeSlug.md

@@ -1,5 +1,7 @@
 ---
 slug: ../../../../../../../../rootTryToEscapeSlug
+pagination_next: headingAsTitle
+pagination_prev: foo/baz
 ---
 
 Lorem

package/src/__tests__/__fixtures__/simple-site/sidebars.json

@@ -4,7 +4,21 @@
       {
         "type": "category",
         "label": "foo",
-        "items": ["foo/bar", "foo/baz"] 
+        "items": ["foo/bar", "foo/baz"]
+      },
+      {
+        "type": "category",
+        "label": "Slugs",
+        "items": [
+          "rootAbsoluteSlug",
+          "rootRelativeSlug",
+          "rootResolvedSlug",
+          "rootTryToEscapeSlug"
+        ]
+      },
+      {
+        "type": "doc",
+        "id": "headingAsTitle"
       },
       {
         "type": "link",

package/src/__tests__/__fixtures__/site-with-doc-label/docs/hello-1.md

@@ -1,6 +1,7 @@
 ---
 id: hello-1
 title: Hello 1
+slug: /
 ---
 
 Hello World 1!

package/src/__tests__/__fixtures__/versioned-site/docs/foo/bar.md

@@ -1,4 +1,10 @@
 ---
 slug: barSlug
+tags:
+  - barTag 1
+  - barTag-2
+  - label: barTag 3
+    permalink: barTag-3-permalink
 ---
+
 This is `next` version of bar.

package/src/__tests__/__fixtures__/versioned-site/docs/hello.md

@@ -1 +1,4 @@
+---
+slug: /
+---
 Hello `next` !

package/src/__tests__/__fixtures__/versioned-site/i18n/en/docusaurus-plugin-content-docs/version-1.0.0/hello.md

@@ -1 +1,4 @@
+---
+slug: /
+---
 Hello `1.0.0` ! (translated en)

package/src/__tests__/__fixtures__/versioned-site/i18n/fr/docusaurus-plugin-content-docs/version-1.0.0/hello.md

@@ -1 +1,4 @@
+---
+slug: /
+---
 Hello `1.0.0` ! (translated fr)

package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-1.0.0/hello.md

@@ -1 +1,4 @@
+---
+slug: /
+---
 Hello `1.0.0` !

package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-1.0.1/_partials/somePartial.md

@@ -0,0 +1,3 @@
+This is a partial in file/folder starting with _:
+
+It should be excluded by default

package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-1.0.1/_partials/subfolder/somePartial.md

@@ -0,0 +1,3 @@
+This is a partial in file/folder starting with _:
+
+It should be excluded by default

package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-1.0.1/_somePartial.md

@@ -0,0 +1,3 @@
+This is a partial in file/folder starting with \_:
+
+It should be excluded by default

package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-1.0.1/hello.md

@@ -1 +1,4 @@
+---
+slug: /
+---
 Hello `1.0.1` !

package/src/__tests__/__fixtures__/versioned-site/versioned_sidebars/version-1.0.1-sidebars.json

@@ -1,7 +1,7 @@
 {
-  "version-1.0.1/docs": {
+  "VersionedSideBarNameDoesNotMatter/docs": {
     "Test": [
-      "version-1.0.1/foo/bar"
+      "foo/bar"
     ],
     "Guides": [
       "version-1.0.1/hello"

package/src/__tests__/__snapshots__/cli.test.ts.snap

@@ -2,89 +2,64 @@
 
 exports[`docsVersion first time versioning 1`] = `
 Object {
-  "version-1.0.0/docs": Array [
-    Object {
-      "collapsed": true,
-      "items": Array [
-        Object {
-          "collapsed": true,
-          "items": Array [
-            Object {
-              "id": "version-1.0.0/foo/bar",
-              "type": "doc",
-            },
-            Object {
-              "id": "version-1.0.0/foo/baz",
-              "type": "doc",
-            },
-          ],
-          "label": "foo",
-          "type": "category",
-        },
-        Object {
-          "href": "https://github.com",
-          "label": "Github",
-          "type": "link",
-        },
-        Object {
-          "id": "version-1.0.0/hello",
-          "type": "ref",
-        },
-      ],
-      "label": "Test",
-      "type": "category",
-    },
-    Object {
-      "collapsed": true,
-      "items": Array [
-        Object {
-          "id": "version-1.0.0/hello",
-          "type": "doc",
-        },
-      ],
-      "label": "Guides",
-      "type": "category",
-    },
-  ],
+  "docs": Object {
+    "Guides": Array [
+      "hello",
+    ],
+    "Test": Array [
+      Object {
+        "items": Array [
+          "foo/bar",
+          "foo/baz",
+        ],
+        "label": "foo",
+        "type": "category",
+      },
+      Object {
+        "items": Array [
+          "rootAbsoluteSlug",
+          "rootRelativeSlug",
+          "rootResolvedSlug",
+          "rootTryToEscapeSlug",
+        ],
+        "label": "Slugs",
+        "type": "category",
+      },
+      Object {
+        "id": "headingAsTitle",
+        "type": "doc",
+      },
+      Object {
+        "href": "https://github.com",
+        "label": "Github",
+        "type": "link",
+      },
+      Object {
+        "id": "hello",
+        "type": "ref",
+      },
+    ],
+  },
 }
 `;
 
 exports[`docsVersion not the first time versioning 1`] = `
 Object {
-  "version-2.0.0/docs": Array [
-    Object {
-      "collapsed": true,
-      "items": Array [
-        Object {
-          "id": "version-2.0.0/foo/bar",
-          "type": "doc",
-        },
-      ],
-      "label": "Test",
-      "type": "category",
-    },
-    Object {
-      "collapsed": true,
-      "items": Array [
-        Object {
-          "id": "version-2.0.0/hello",
-          "type": "doc",
-        },
-      ],
-      "label": "Guides",
-      "type": "category",
-    },
-  ],
+  "docs": Object {
+    "Guides": Array [
+      "hello",
+    ],
+    "Test": Array [
+      "foo/bar",
+    ],
+  },
 }
 `;
 
 exports[`docsVersion second docs instance versioning 1`] = `
 Object {
-  "version-2.0.0/community": Array [
-    Object {
-      "id": "version-2.0.0/team",
-      "type": "doc",
-    },
+  "community": Array [
+    "team",
   ],
 }
 `;