@docusaurus/plugin-content-docs 2.0.0-beta.16 → 2.0.0-beta.19

package/lib/docs.js

@@ -6,18 +6,17 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createDocsByIdIndex = exports.getDocIds = exports.splitPath = exports.toCategoryIndexMatcherParam = exports.isCategoryIndex = exports.getMainDocId = exports.addDocNavigation = exports.processDocMetadata = exports.readVersionDocs = exports.readDocFile = void 0;
+exports.createDocsByIdIndex = exports.getDocIds = exports.toCategoryIndexMatcherParam = exports.isCategoryIndex = exports.getMainDocId = exports.addDocNavigation = exports.processDocMetadata = exports.readVersionDocs = exports.readDocFile = void 0;
 const tslib_1 = require("tslib");
-const path_1 = (0, tslib_1.__importDefault)(require("path"));
-const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
-const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
+const path_1 = tslib_1.__importDefault(require("path"));
+const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const utils_1 = require("@docusaurus/utils");
 const lastUpdate_1 = require("./lastUpdate");
-const slug_1 = (0, tslib_1.__importDefault)(require("./slug"));
+const slug_1 = tslib_1.__importDefault(require("./slug"));
 const constants_1 = require("./constants");
-const versions_1 = require("./versions");
 const numberPrefix_1 = require("./numberPrefix");
-const docFrontMatter_1 = require("./docFrontMatter");
+const frontMatter_1 = require("./frontMatter");
 const utils_2 = require("./sidebars/utils");
 async function readLastUpdateData(filePath, options) {
     const { showLastUpdateAuthor, showLastUpdateTime } = options;
@@ -40,7 +39,7 @@ async function readLastUpdateData(filePath, options) {
     return {};
 }
 async function readDocFile(versionMetadata, source, options) {
-    const contentPath = await (0, utils_1.getFolderContainingFile)((0, versions_1.getDocsDirPaths)(versionMetadata), source);
+    const contentPath = await (0, utils_1.getFolderContainingFile)((0, utils_1.getContentPathList)(versionMetadata), source);
     const filePath = path_1.default.join(contentPath, source);
     const [content, lastUpdate] = await Promise.all([
         fs_extra_1.default.readFile(filePath, 'utf-8'),
@@ -57,33 +56,34 @@ async function readVersionDocs(versionMetadata, options) {
     return Promise.all(sources.map((source) => readDocFile(versionMetadata, source, options)));
 }
 exports.readVersionDocs = readVersionDocs;
-function doProcessDocMetadata({ docFile, versionMetadata, context, options, }) {
-    var _a, _b, _c, _d, _e, _f;
+/** Docs with draft front matter are only considered draft in production. */
+function isDraftForEnvironment({ env, frontMatter, }) {
+    return (env === 'production' && frontMatter.draft) ?? false;
+}
+function doProcessDocMetadata({ docFile, versionMetadata, context, options, env, }) {
     const { source, content, lastUpdate, contentPath, filePath } = docFile;
     const { siteDir, i18n } = context;
     const { frontMatter: unsafeFrontMatter, contentTitle, excerpt, } = (0, utils_1.parseMarkdownString)(content);
-    const frontMatter = (0, docFrontMatter_1.validateDocFrontMatter)(unsafeFrontMatter);
+    const frontMatter = (0, frontMatter_1.validateDocFrontMatter)(unsafeFrontMatter);
     const { custom_edit_url: customEditURL, 
     // Strip number prefixes by default
     // (01-MyFolder/01-MyDoc.md => MyFolder/MyDoc)
     // but allow to disable this behavior with front matter
     parse_number_prefixes: parseNumberPrefixes = true, } = frontMatter;
-    // ex: api/plugins/myDoc -> myDoc
-    // ex: myDoc -> myDoc
+    // E.g. api/plugins/myDoc -> myDoc; myDoc -> myDoc
     const sourceFileNameWithoutExtension = path_1.default.basename(source, path_1.default.extname(source));
-    // ex: api/plugins/myDoc -> api/plugins
-    // ex: myDoc -> .
+    // E.g. api/plugins/myDoc -> api/plugins; myDoc -> .
     const sourceDirName = path_1.default.dirname(source);
     const { filename: unprefixedFileName, numberPrefix } = parseNumberPrefixes
         ? options.numberPrefixParser(sourceFileNameWithoutExtension)
         : { filename: sourceFileNameWithoutExtension, numberPrefix: undefined };
-    const baseID = (_a = frontMatter.id) !== null && _a !== void 0 ? _a : unprefixedFileName;
+    const baseID = frontMatter.id ?? unprefixedFileName;
     if (baseID.includes('/')) {
         throw new Error(`Document id "${baseID}" cannot include slash.`);
     }
     // For autogenerated sidebars, sidebar position can come from filename number
     // prefix or front matter
-    const sidebarPosition = (_b = frontMatter.sidebar_position) !== null && _b !== void 0 ? _b : numberPrefix;
+    const sidebarPosition = frontMatter.sidebar_position ?? numberPrefix;
     // TODO legacy retrocompatibility
     // The same doc in 2 distinct version could keep the same id,
     // we just need to namespace the data by version
@@ -118,9 +118,9 @@ function doProcessDocMetadata({ docFile, versionMetadata, context, options, }) {
     // Note: the title is used by default for page title, sidebar label,
     // pagination buttons... frontMatter.title should be used in priority over
     // contentTitle (because it can contain markdown/JSX syntax)
-    const title = (_d = (_c = frontMatter.title) !== null && _c !== void 0 ? _c : contentTitle) !== null && _d !== void 0 ? _d : baseID;
-    const description = (_f = (_e = frontMatter.description) !== null && _e !== void 0 ? _e : excerpt) !== null && _f !== void 0 ? _f : '';
-    const permalink = (0, utils_1.normalizeUrl)([versionMetadata.versionPath, docSlug]);
+    const title = frontMatter.title ?? contentTitle ?? baseID;
+    const description = frontMatter.description ?? excerpt ?? '';
+    const permalink = (0, utils_1.normalizeUrl)([versionMetadata.path, docSlug]);
     function getDocEditUrl() {
         const relativeFilePath = path_1.default.relative(contentPath, filePath);
         if (typeof options.editUrl === 'function') {
@@ -135,12 +135,13 @@ function doProcessDocMetadata({ docFile, versionMetadata, context, options, }) {
         else if (typeof options.editUrl === 'string') {
             const isLocalized = contentPath === versionMetadata.contentPathLocalized;
             const baseVersionEditUrl = isLocalized && options.editLocalizedFiles
-                ? versionMetadata.versionEditUrlLocalized
-                : versionMetadata.versionEditUrl;
+                ? versionMetadata.editUrlLocalized
+                : versionMetadata.editUrl;
             return (0, utils_1.getEditUrl)(relativeFilePath, baseVersionEditUrl);
         }
         return undefined;
     }
+    const draft = isDraftForEnvironment({ env, frontMatter });
     // Assign all of object properties during instantiation (if possible) for
     // NodeJS optimization.
     // Adding properties to object after instantiation will cause hidden
@@ -154,13 +155,16 @@ function doProcessDocMetadata({ docFile, versionMetadata, context, options, }) {
         sourceDirName,
         slug: docSlug,
         permalink,
+        draft,
         editUrl: customEditURL !== undefined ? customEditURL : getDocEditUrl(),
         tags: (0, utils_1.normalizeFrontMatterTags)(versionMetadata.tagsPath, frontMatter.tags),
         version: versionMetadata.versionName,
         lastUpdatedBy: lastUpdate.lastUpdatedBy,
         lastUpdatedAt: lastUpdate.lastUpdatedAt,
         formattedLastUpdatedAt: lastUpdate.lastUpdatedAt
-            ? new Intl.DateTimeFormat(i18n.currentLocale).format(lastUpdate.lastUpdatedAt * 1000)
+            ? new Intl.DateTimeFormat(i18n.currentLocale, {
+                calendar: i18n.localeConfigs[i18n.currentLocale].calendar,
+            }).format(lastUpdate.lastUpdatedAt * 1000)
             : undefined,
         sidebarPosition,
         frontMatter,
@@ -202,7 +206,7 @@ function addDocNavigation(docsBase, sidebarsUtils, sidebarFilePath) {
         return { ...doc, sidebar: navigation.sidebarName, previous, next };
     }
     const docsWithNavigation = docsBase.map(addNavData);
-    // sort to ensure consistent output for tests
+    // Sort to ensure consistent output for tests
     docsWithNavigation.sort((a, b) => a.id.localeCompare(b.id));
     return docsWithNavigation;
 }
@@ -241,15 +245,18 @@ exports.getMainDocId = getMainDocId;
 // - Slugs do not end with a weird "/index" suffix
 // - Auto-generated sidebar categories link to them as intro
 const isCategoryIndex = ({ fileName, directories, }) => {
-    var _a;
     const eligibleDocIndexNames = [
         'index',
         'readme',
-        (_a = directories[0]) === null || _a === void 0 ? void 0 : _a.toLowerCase(),
+        directories[0]?.toLowerCase(),
     ];
     return eligibleDocIndexNames.includes(fileName.toLowerCase());
 };
 exports.isCategoryIndex = isCategoryIndex;
+/**
+ * `guides/sidebar/autogenerated.md` ->
+ *   `'autogenerated', '.md', ['sidebar', 'guides']`
+ */
 function toCategoryIndexMatcherParam({ source, sourceDirName, }) {
     // source + sourceDirName are always posix-style
     return {
@@ -259,18 +266,6 @@ function toCategoryIndexMatcherParam({ source, sourceDirName, }) {
     };
 }
 exports.toCategoryIndexMatcherParam = toCategoryIndexMatcherParam;
-/**
- * `guides/sidebar/autogenerated.md` ->
- *   `'autogenerated', '.md', ['sidebar', 'guides']`
- */
-function splitPath(str) {
-    return {
-        fileName: path_1.default.parse(str).name,
-        extension: path_1.default.parse(str).ext,
-        directories: path_1.default.dirname(str).split(path_1.default.sep).reverse(),
-    };
-}
-exports.splitPath = splitPath;
 // Return both doc ids
 // TODO legacy retro-compatibility due to old versioned sidebars using
 // versioned doc ids ("id" should be removed & "versionedId" should be renamed
@@ -279,7 +274,7 @@ function getDocIds(doc) {
     return [doc.unversionedId, doc.id];
 }
 exports.getDocIds = getDocIds;
-// docs are indexed by both versioned and unversioned ids at the same time
+// Docs are indexed by both versioned and unversioned ids at the same time
 // TODO legacy retro-compatibility due to old versioned sidebars using
 // versioned doc ids ("id" should be removed & "versionedId" should be renamed
 // to "id")

package/lib/{docFrontMatter.d.ts → frontMatter.d.ts}

@@ -4,5 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { DocFrontMatter } from './types';
-export declare function validateDocFrontMatter(frontMatter: Record<string, unknown>): DocFrontMatter;
+import type { DocFrontMatter } from '@docusaurus/plugin-content-docs';
+export declare function validateDocFrontMatter(frontMatter: {
+    [key: string]: unknown;
+}): DocFrontMatter;

package/lib/{docFrontMatter.js → frontMatter.js}

@@ -14,11 +14,13 @@ const utils_validation_1 = require("@docusaurus/utils-validation");
 // We use default values in code instead
 const DocFrontMatterSchema = utils_validation_1.JoiFrontMatter.object({
     id: utils_validation_1.JoiFrontMatter.string(),
+    // See https://github.com/facebook/docusaurus/issues/4591#issuecomment-822372398
     title: utils_validation_1.JoiFrontMatter.string().allow(''),
     hide_title: utils_validation_1.JoiFrontMatter.boolean(),
     hide_table_of_contents: utils_validation_1.JoiFrontMatter.boolean(),
     keywords: utils_validation_1.JoiFrontMatter.array().items(utils_validation_1.JoiFrontMatter.string().required()),
     image: utils_validation_1.URISchema,
+    // See https://github.com/facebook/docusaurus/issues/4591#issuecomment-822372398
     description: utils_validation_1.JoiFrontMatter.string().allow(''),
     slug: utils_validation_1.JoiFrontMatter.string(),
     sidebar_label: utils_validation_1.JoiFrontMatter.string(),
@@ -32,6 +34,7 @@ const DocFrontMatterSchema = utils_validation_1.JoiFrontMatter.object({
     parse_number_prefixes: utils_validation_1.JoiFrontMatter.boolean(),
     pagination_next: utils_validation_1.JoiFrontMatter.string().allow(null),
     pagination_prev: utils_validation_1.JoiFrontMatter.string().allow(null),
+    draft: utils_validation_1.JoiFrontMatter.boolean(),
     ...utils_validation_1.FrontMatterTOCHeadingLevels,
 }).unknown();
 function validateDocFrontMatter(frontMatter) {

package/lib/globalData.d.ts

@@ -4,10 +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 { Sidebars } from './sidebars/types';
-import type { CategoryGeneratedIndexMetadata, DocMetadata, LoadedVersion } from './types';
-import type { GlobalVersion, GlobalSidebar, GlobalDoc } from '@docusaurus/plugin-content-docs/client';
-export declare function toGlobalDataDoc(doc: DocMetadata): GlobalDoc;
-export declare function toGlobalDataGeneratedIndex(doc: CategoryGeneratedIndexMetadata): GlobalDoc;
-export declare function toGlobalSidebars(sidebars: Sidebars, version: LoadedVersion): Record<string, GlobalSidebar>;
-export declare function toGlobalDataVersion(version: LoadedVersion): GlobalVersion;
+import type { FullVersion } from './types';
+import type { GlobalVersion } from '@docusaurus/plugin-content-docs/client';
+export declare function toGlobalDataVersion(version: FullVersion): GlobalVersion;

package/lib/globalData.js

@@ -6,11 +6,10 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toGlobalDataVersion = exports.toGlobalSidebars = exports.toGlobalDataGeneratedIndex = exports.toGlobalDataDoc = void 0;
+exports.toGlobalDataVersion = void 0;
 const tslib_1 = require("tslib");
-const lodash_1 = (0, tslib_1.__importDefault)(require("lodash"));
-const utils_1 = require("@docusaurus/utils");
-const utils_2 = require("./sidebars/utils");
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
+const docs_1 = require("./docs");
 function toGlobalDataDoc(doc) {
     return {
         id: doc.unversionedId,
@@ -18,7 +17,6 @@ function toGlobalDataDoc(doc) {
         sidebar: doc.sidebar,
     };
 }
-exports.toGlobalDataDoc = toGlobalDataDoc;
 function toGlobalDataGeneratedIndex(doc) {
     return {
         id: doc.slug,
@@ -26,35 +24,33 @@ function toGlobalDataGeneratedIndex(doc) {
         sidebar: doc.sidebar,
     };
 }
-exports.toGlobalDataGeneratedIndex = toGlobalDataGeneratedIndex;
 function toGlobalSidebars(sidebars, version) {
-    const { getFirstLink } = (0, utils_2.createSidebarsUtils)(sidebars);
     return lodash_1.default.mapValues(sidebars, (sidebar, sidebarId) => {
-        const firstLink = getFirstLink(sidebarId);
+        const firstLink = version.sidebarsUtils.getFirstLink(sidebarId);
         if (!firstLink) {
             return {};
         }
         return {
             link: {
                 path: firstLink.type === 'generated-index'
-                    ? (0, utils_1.normalizeUrl)([version.versionPath, firstLink.slug])
+                    ? firstLink.permalink
                     : version.docs.find((doc) => doc.id === firstLink.id || doc.unversionedId === firstLink.id).permalink,
                 label: firstLink.label,
             },
         };
     });
 }
-exports.toGlobalSidebars = toGlobalSidebars;
 function toGlobalDataVersion(version) {
     return {
         name: version.versionName,
-        label: version.versionLabel,
+        label: version.label,
         isLast: version.isLast,
-        path: version.versionPath,
-        mainDocId: version.mainDocId,
+        path: version.path,
+        mainDocId: (0, docs_1.getMainDocId)(version),
         docs: version.docs
             .map(toGlobalDataDoc)
             .concat(version.categoryGeneratedIndices.map(toGlobalDataGeneratedIndex)),
+        draftIds: version.drafts.map((doc) => doc.unversionedId),
         sidebars: toGlobalSidebars(version.sidebars, version),
     };
 }

package/lib/index.d.ts

@@ -5,7 +5,6 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { LoadContext, Plugin } from '@docusaurus/types';
-import type { LoadedContent } from './types';
-import type { PluginOptions } from '@docusaurus/plugin-content-docs';
+import type { PluginOptions, LoadedContent } from '@docusaurus/plugin-content-docs';
 export default function pluginContentDocs(context: LoadContext, options: PluginOptions): Promise<Plugin<LoadedContent>>;
 export { validateOptions } from './options';

package/lib/index.js

@@ -8,7 +8,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateOptions = void 0;
 const tslib_1 = require("tslib");
-const path_1 = (0, tslib_1.__importDefault)(require("path"));
+const path_1 = tslib_1.__importDefault(require("path"));
 const utils_1 = require("@docusaurus/utils");
 const sidebars_1 = require("./sidebars");
 const generator_1 = require("./sidebars/generator");
@@ -18,17 +18,19 @@ const cli_1 = require("./cli");
 const constants_1 = require("./constants");
 const globalData_1 = require("./globalData");
 const props_1 = require("./props");
+const categoryGeneratedIndex_1 = require("./categoryGeneratedIndex");
 const translations_1 = require("./translations");
-const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const tags_1 = require("./tags");
 const routes_1 = require("./routes");
 const utils_2 = require("./sidebars/utils");
-const categoryGeneratedIndex_1 = require("./categoryGeneratedIndex");
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
 async function pluginContentDocs(context, options) {
-    var _a;
     const { siteDir, generatedFilesDir, baseUrl, siteConfig } = context;
+    // Mutate options to resolve sidebar path according to siteDir
+    options.sidebarPath = (0, sidebars_1.resolveSidebarPathOption)(siteDir, options.sidebarPath);
     const versionsMetadata = await (0, versions_1.readVersionsMetadata)({ context, options });
-    const pluginId = (_a = options.id) !== null && _a !== void 0 ? _a : 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))}`;
@@ -49,21 +51,16 @@ 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);
             });
         },
-        async getTranslationFiles({ content }) {
+        getTranslationFiles({ content }) {
             return (0, translations_1.getLoadedContentTranslationFiles)(content);
         },
         getPathsToWatch() {
             function getVersionPathsToWatch(version) {
                 const result = [
-                    ...options.include.flatMap((pattern) => (0, versions_1.getDocsDirPaths)(version).map((docsDirPath) => `${docsDirPath}/${pattern}`)),
+                    ...options.include.flatMap((pattern) => (0, utils_1.getContentPathList)(version).map((docsDirPath) => `${docsDirPath}/${pattern}`)),
                     `${version.contentPath}/**/${generator_1.CategoryMetadataFilenamePattern}`,
                 ];
                 if (typeof version.sidebarFilePath === 'string') {
@@ -85,16 +82,19 @@ async function pluginContentDocs(context, options) {
                         versionMetadata,
                         context,
                         options,
+                        env: process.env.NODE_ENV,
                     });
                 }
                 return Promise.all(docFiles.map(processVersionDoc));
             }
             async function doLoadVersion(versionMetadata) {
-                const docs = await loadVersionDocsBase(versionMetadata);
+                const docsBase = await loadVersionDocsBase(versionMetadata);
+                const [drafts, docs] = lodash_1.default.partition(docsBase, (doc) => doc.draft);
                 const sidebars = await (0, sidebars_1.loadSidebars)(versionMetadata.sidebarFilePath, {
                     sidebarItemsGenerator: options.sidebarItemsGenerator,
                     numberPrefixParser: options.numberPrefixParser,
                     docs,
+                    drafts,
                     version: versionMetadata,
                     sidebarOptions: {
                         sidebarCollapsed: options.sidebarCollapsed,
@@ -106,12 +106,8 @@ async function pluginContentDocs(context, options) {
                 return {
                     ...versionMetadata,
                     docs: (0, docs_1.addDocNavigation)(docs, sidebarsUtils, versionMetadata.sidebarFilePath),
+                    drafts,
                     sidebars,
-                    mainDocId: (0, docs_1.getMainDocId)({ docs, sidebarsUtils }),
-                    categoryGeneratedIndices: (0, categoryGeneratedIndex_1.getCategoryGeneratedIndexMetadataList)({
-                        docs,
-                        sidebarsUtils,
-                    }),
                 };
             }
             async function loadVersion(versionMetadata) {
@@ -134,17 +130,28 @@ async function pluginContentDocs(context, options) {
             const { loadedVersions } = content;
             const { docLayoutComponent, docItemComponent, docCategoryGeneratedIndexComponent, breadcrumbs, } = options;
             const { addRoute, createData, setGlobalData } = actions;
+            const versions = loadedVersions.map((version) => {
+                const sidebarsUtils = (0, utils_2.createSidebarsUtils)(version.sidebars);
+                return {
+                    ...version,
+                    sidebarsUtils,
+                    categoryGeneratedIndices: (0, categoryGeneratedIndex_1.getCategoryGeneratedIndexMetadataList)({
+                        docs: version.docs,
+                        sidebarsUtils,
+                    }),
+                };
+            });
             async function createVersionTagsRoutes(version) {
                 const versionTags = (0, tags_1.getVersionTags)(version.docs);
                 // TODO tags should be a sub route of the version route
                 async function createTagsListPage() {
                     const tagsProp = Object.values(versionTags).map((tagValue) => ({
-                        name: tagValue.name,
+                        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,
@@ -176,8 +183,8 @@ async function pluginContentDocs(context, options) {
                 await createTagsListPage();
                 await Promise.all(Object.values(versionTags).map(createTagDocListPage));
             }
-            await Promise.all(loadedVersions.map((loadedVersion) => (0, routes_1.createVersionRoutes)({
-                loadedVersion,
+            await Promise.all(versions.map((version) => (0, routes_1.createVersionRoutes)({
+                version,
                 docItemComponent,
                 docLayoutComponent,
                 docCategoryGeneratedIndexComponent,
@@ -186,10 +193,10 @@ async function pluginContentDocs(context, options) {
                 actions,
             })));
             // TODO tags should be a sub route of the version route
-            await Promise.all(loadedVersions.map(createVersionTagsRoutes));
+            await Promise.all(versions.map(createVersionTagsRoutes));
             setGlobalData({
                 path: (0, utils_1.normalizeUrl)([baseUrl, options.routeBasePath]),
-                versions: loadedVersions.map(globalData_1.toGlobalDataVersion),
+                versions: versions.map(globalData_1.toGlobalDataVersion),
                 breadcrumbs,
             });
         },
@@ -212,7 +219,7 @@ async function pluginContentDocs(context, options) {
                 },
             };
             function createMDXLoaderRule() {
-                const contentDirs = versionsMetadata.flatMap(versions_1.getDocsDirPaths);
+                const contentDirs = versionsMetadata.flatMap(utils_1.getContentPathList);
                 return {
                     test: /\.mdx?$/i,
                     include: contentDirs

package/lib/lastUpdate.d.ts

@@ -4,9 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-declare type FileLastUpdateData = {
-    timestamp?: number;
-    author?: string;
-};
-export declare function getFileLastUpdate(filePath?: string): Promise<FileLastUpdateData | null>;
-export {};
+export declare function getFileLastUpdate(filePath?: string): Promise<{
+    timestamp: number;
+    author: string;
+} | null>;

package/lib/lastUpdate.js

@@ -8,9 +8,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getFileLastUpdate = void 0;
 const tslib_1 = require("tslib");
-const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const utils_1 = require("@docusaurus/utils");
 let showedGitRequirementError = false;
+let showedFileNotTrackedError = false;
 async function getFileLastUpdate(filePath) {
     if (!filePath) {
         return null;
@@ -25,12 +26,20 @@ async function getFileLastUpdate(filePath) {
         return { timestamp: result.timestamp, author: result.author };
     }
     catch (err) {
-        if (err instanceof utils_1.GitNotFoundError && !showedGitRequirementError) {
-            logger_1.default.warn('Sorry, the docs plugin last update options require Git.');
-            showedGitRequirementError = true;
+        if (err instanceof utils_1.GitNotFoundError) {
+            if (!showedGitRequirementError) {
+                logger_1.default.warn('Sorry, the docs plugin last update options require Git.');
+                showedGitRequirementError = true;
+            }
+        }
+        else if (err instanceof utils_1.FileNotTrackedError) {
+            if (!showedFileNotTrackedError) {
+                logger_1.default.warn('Cannot infer the update date for some files, as they are not tracked by git.');
+                showedFileNotTrackedError = true;
+            }
         }
         else {
-            logger_1.default.error(err);
+            logger_1.default.warn(err);
         }
         return null;
     }

package/lib/markdown/index.js

@@ -11,6 +11,6 @@ function markdownLoader(source) {
     const fileString = source;
     const callback = this.async();
     const options = this.getOptions();
-    return (callback && callback(null, (0, linkify_1.linkify)(fileString, this.resourcePath, options)));
+    return callback?.(null, (0, linkify_1.linkify)(fileString, this.resourcePath, options));
 }
 exports.default = markdownLoader;

package/lib/markdown/linkify.js

@@ -7,10 +7,13 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.linkify = void 0;
-const versions_1 = require("../versions");
 const utils_1 = require("@docusaurus/utils");
 function getVersion(filePath, options) {
-    const versionFound = options.versionsMetadata.find((version) => (0, versions_1.getDocsDirPaths)(version).some((docsDirPath) => filePath.startsWith(docsDirPath)));
+    const versionFound = options.versionsMetadata.find((version) => (0, utils_1.getContentPathList)(version).some((docsDirPath) => filePath.startsWith(docsDirPath)));
+    // At this point, this should never happen, because the MDX loaders' paths are
+    // literally using the version content paths; but if we allow sourcing content
+    // from outside the docs directory (through the `include` option, for example;
+    // is there a compelling use-case?), this would actually be testable
     if (!versionFound) {
         throw new Error(`Unexpected error: Markdown file at "${filePath}" does not belong to any docs version!`);
     }

package/lib/numberPrefix.js

@@ -8,34 +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) => {
-    var _a, _b, _c;
-    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 = (_b = (_a = match === null || match === void 0 ? void 0 : match.groups) === null || _a === void 0 ? void 0 : _a.suffix) !== null && _b !== void 0 ? _b : filename;
-    const numberPrefixString = (_c = match === null || match === void 0 ? void 0 : match.groups) === null || _c === void 0 ? void 0 : _c.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/lib/options.d.ts

@@ -4,9 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { PluginOptions } from '@docusaurus/plugin-content-docs';
-import { Joi } from '@docusaurus/utils-validation';
-import type { OptionValidationContext, ValidationResult } from '@docusaurus/types';
+import type { PluginOptions, Options } from '@docusaurus/plugin-content-docs';
+import type { OptionValidationContext } from '@docusaurus/types';
 export declare const DEFAULT_OPTIONS: Omit<PluginOptions, 'id' | 'sidebarPath'>;
-export declare const OptionsSchema: Joi.ObjectSchema<any>;
-export declare function validateOptions({ validate, options: userOptions, }: OptionValidationContext<PluginOptions>): ValidationResult<PluginOptions>;
+export declare function validateOptions({ validate, options: userOptions, }: OptionValidationContext<Options, PluginOptions>): PluginOptions;