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

package/src/types.ts

@@ -7,13 +7,14 @@
 
 /// <reference types="@docusaurus/module-type-aliases" />
 
-import type {Sidebars} from './sidebars/types';
-import type {Tag, FrontMatterTag} from '@docusaurus/utils';
+import type {BrokenMarkdownLink, Tag} from '@docusaurus/utils';
 import type {
-  BrokenMarkdownLink as IBrokenMarkdownLink,
-  ContentPaths,
-} from '@docusaurus/utils/lib/markdownLinks';
-import type {VersionBanner} from '@docusaurus/plugin-content-docs';
+  VersionMetadata,
+  LastUpdateData,
+  LoadedVersion,
+  CategoryGeneratedIndexMetadata,
+} from '@docusaurus/plugin-content-docs';
+import type {SidebarsUtils} from './sidebars/utils';
 
 export type DocFile = {
   contentPath: string; // /!\ may be localized
@@ -23,121 +24,28 @@ export type DocFile = {
   lastUpdate: LastUpdateData;
 };
 
-export type VersionMetadata = ContentPaths & {
-  versionName: string; // 1.0.0
-  versionLabel: string; // Version 1.0.0
-  versionPath: string; // /baseUrl/docs/1.0.0
-  tagsPath: string;
-  versionEditUrl?: string | undefined;
-  versionEditUrlLocalized?: string | undefined;
-  versionBanner: VersionBanner | null;
-  versionBadge: boolean;
-  versionClassName: string;
-  isLast: boolean;
-  sidebarFilePath: string | false | undefined; // versioned_sidebars/1.0.0.json
-  routePriority: number | undefined; // -1 for the latest docs
-};
-
-export type LastUpdateData = {
-  lastUpdatedAt?: number;
-  formattedLastUpdatedAt?: string;
-  lastUpdatedBy?: string;
-};
-
-export type DocFrontMatter = {
-  // Front matter uses snake case
-  id?: string;
-  title?: string;
-  tags?: FrontMatterTag[];
-  hide_title?: boolean;
-  hide_table_of_contents?: boolean;
-  keywords?: string[];
-  image?: string;
-  description?: string;
-  slug?: string;
-  sidebar_label?: string;
-  sidebar_position?: number;
-  sidebar_class_name?: string;
-  sidebar_custom_props?: Record<string, unknown>;
-  displayed_sidebar?: string | null;
-  pagination_label?: string;
-  custom_edit_url?: string | null;
-  parse_number_prefixes?: boolean;
-  toc_min_heading_level?: number;
-  toc_max_heading_level?: number;
-  pagination_next?: string | null;
-  pagination_prev?: string | null;
-};
-
-export type DocMetadataBase = LastUpdateData & {
-  id: string; // TODO legacy versioned id => try to remove
-  unversionedId: string; // TODO new unversioned id => try to rename to "id"
-  version: string;
-  title: string;
-  description: string;
-  source: string; // @site aliased posix source => "@site/docs/folder/subFolder/subSubFolder/myDoc.md"
-  sourceDirName: string; // posix path relative to the versioned docs folder (can be ".") => "folder/subFolder/subSubFolder"
-  slug: string;
-  permalink: string;
-  sidebarPosition?: number;
-  editUrl?: string | null;
-  tags: Tag[];
-  frontMatter: DocFrontMatter & Record<string, unknown>;
-};
-
-export type DocNavLink = {
-  title: string;
-  permalink: string;
-};
-
-export type DocMetadata = DocMetadataBase & {
-  sidebar?: string;
-  previous?: DocNavLink;
-  next?: DocNavLink;
-};
-
-export type CategoryGeneratedIndexMetadata = {
-  title: string;
-  description?: string;
-  slug: string;
-  permalink: string;
-  sidebar: string;
-  previous?: DocNavLink;
-  next?: DocNavLink;
-  image?: string;
-  keywords?: string | readonly string[];
-};
-
 export type SourceToPermalink = {
   [source: string]: string;
 };
 
-export type VersionTag = {
-  name: string; // normalized name/label of the tag
-  docIds: string[]; // all doc ids having this tag
-  permalink: string; // pathname of the tag
+export type VersionTag = Tag & {
+  /** All doc ids having this tag. */
+  docIds: string[];
 };
 export type VersionTags = {
-  [key: string]: VersionTag;
+  [permalink: string]: VersionTag;
 };
 
-export type LoadedVersion = VersionMetadata & {
-  versionPath: string;
-  mainDocId: string;
-  docs: DocMetadata[];
-  sidebars: Sidebars;
+export type FullVersion = LoadedVersion & {
+  sidebarsUtils: SidebarsUtils;
   categoryGeneratedIndices: CategoryGeneratedIndexMetadata[];
 };
 
-export type LoadedContent = {
-  loadedVersions: LoadedVersion[];
-};
-
-export type BrokenMarkdownLink = IBrokenMarkdownLink<VersionMetadata>;
+export type DocBrokenMarkdownLink = BrokenMarkdownLink<VersionMetadata>;
 
 export type DocsMarkdownOption = {
   versionsMetadata: VersionMetadata[];
   siteDir: string;
   sourceToPermalink: SourceToPermalink;
-  onBrokenMarkdownLink: (brokenMarkdownLink: BrokenMarkdownLink) => void;
+  onBrokenMarkdownLink: (brokenMarkdownLink: DocBrokenMarkdownLink) => void;
 };

package/src/versions/files.ts

@@ -0,0 +1,220 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import path from 'path';
+import fs from 'fs-extra';
+import {
+  VERSIONS_JSON_FILE,
+  VERSIONED_DOCS_DIR,
+  VERSIONED_SIDEBARS_DIR,
+  CURRENT_VERSION_NAME,
+} from '../constants';
+import {validateVersionNames} from './validation';
+import {getPluginI18nPath, DEFAULT_PLUGIN_ID} from '@docusaurus/utils';
+import type {
+  PluginOptions,
+  VersionMetadata,
+} from '@docusaurus/plugin-content-docs';
+import type {VersionContext} from './index';
+
+/** Add a prefix like `community_version-1.0.0`. No-op for default instance. */
+function addPluginIdPrefix(fileOrDir: string, pluginId: string): string {
+  return pluginId === DEFAULT_PLUGIN_ID
+    ? fileOrDir
+    : `${pluginId}_${fileOrDir}`;
+}
+
+/** `[siteDir]/community_versioned_docs/version-1.0.0` */
+export function getVersionDocsDirPath(
+  siteDir: string,
+  pluginId: string,
+  versionName: string,
+): string {
+  return path.join(
+    siteDir,
+    addPluginIdPrefix(VERSIONED_DOCS_DIR, pluginId),
+    `version-${versionName}`,
+  );
+}
+
+/** `[siteDir]/community_versioned_sidebars/version-1.0.0-sidebars.json` */
+export function getVersionSidebarsPath(
+  siteDir: string,
+  pluginId: string,
+  versionName: string,
+): string {
+  return path.join(
+    siteDir,
+    addPluginIdPrefix(VERSIONED_SIDEBARS_DIR, pluginId),
+    `version-${versionName}-sidebars.json`,
+  );
+}
+
+export function getDocsDirPathLocalized({
+  siteDir,
+  locale,
+  pluginId,
+  versionName,
+}: {
+  siteDir: string;
+  locale: string;
+  pluginId: string;
+  versionName: string;
+}): string {
+  return getPluginI18nPath({
+    siteDir,
+    locale,
+    pluginName: 'docusaurus-plugin-content-docs',
+    pluginId,
+    subPaths: [
+      versionName === CURRENT_VERSION_NAME
+        ? CURRENT_VERSION_NAME
+        : `version-${versionName}`,
+    ],
+  });
+}
+
+/** `community` => `[siteDir]/community_versions.json` */
+export function getVersionsFilePath(siteDir: string, pluginId: string): string {
+  return path.join(siteDir, addPluginIdPrefix(VERSIONS_JSON_FILE, pluginId));
+}
+
+/**
+ * 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.
+ */
+async function readVersionsFile(
+  siteDir: string,
+  pluginId: string,
+): Promise<string[] | null> {
+  const versionsFilePath = getVersionsFilePath(siteDir, pluginId);
+  if (await fs.pathExists(versionsFilePath)) {
+    const content = await fs.readJSON(versionsFilePath);
+    validateVersionNames(content);
+    return content;
+  }
+  return null;
+}
+
+/**
+ * Reads the `versions.json` file, and returns an ordered list of version names.
+ *
+ * - If `disableVersioning` is turned on, it will return `["current"]` (requires
+ * `includeCurrentVersion` to be true);
+ * - If `includeCurrentVersion` is turned on, "current" will be inserted at the
+ * beginning, if not already there.
+ *
+ * You need to use {@link filterVersions} after this.
+ *
+ * @throws Throws an error if `disableVersioning: true` but `versions.json`
+ * doesn't exist (i.e. site is not versioned)
+ * @throws Throws an error if versions list is empty (empty `versions.json` or
+ * `disableVersioning` is true, and not including current version)
+ */
+export async function readVersionNames(
+  siteDir: string,
+  options: PluginOptions,
+): Promise<string[]> {
+  const versionFileContent = await readVersionsFile(siteDir, options.id);
+
+  if (!versionFileContent && options.disableVersioning) {
+    throw new Error(
+      `Docs: using "disableVersioning: true" option on a non-versioned site does not make sense.`,
+    );
+  }
+
+  const versions = options.disableVersioning ? [] : versionFileContent ?? [];
+
+  // We add the current version at the beginning, unless:
+  // - user don't want to; or
+  // - it's already been explicitly added to versions.json
+  if (
+    options.includeCurrentVersion &&
+    !versions.includes(CURRENT_VERSION_NAME)
+  ) {
+    versions.unshift(CURRENT_VERSION_NAME);
+  }
+
+  if (versions.length === 0) {
+    throw new Error(
+      `It is not possible to use docs without any version. No version is included because you have requested to not include ${path.resolve(
+        options.path,
+      )} through "includeCurrentVersion: false", while ${
+        options.disableVersioning
+          ? 'versioning is disabled with "disableVersioning: true"'
+          : `the versions file is empty/non-existent`
+      }.`,
+    );
+  }
+
+  return versions;
+}
+
+/**
+ * Gets the path-related version metadata.
+ *
+ * @throws Throws if the resolved docs folder or sidebars file doesn't exist.
+ * Does not throw if a versioned sidebar is missing (since we don't create empty
+ * files).
+ */
+export async function getVersionMetadataPaths({
+  versionName,
+  context,
+  options,
+}: VersionContext): Promise<
+  Pick<
+    VersionMetadata,
+    'contentPath' | 'contentPathLocalized' | 'sidebarFilePath'
+  >
+> {
+  const isCurrent = versionName === CURRENT_VERSION_NAME;
+  const contentPathLocalized = getDocsDirPathLocalized({
+    siteDir: context.siteDir,
+    locale: context.i18n.currentLocale,
+    pluginId: options.id,
+    versionName,
+  });
+  const contentPath = isCurrent
+    ? path.resolve(context.siteDir, options.path)
+    : getVersionDocsDirPath(context.siteDir, options.id, versionName);
+  const sidebarFilePath = isCurrent
+    ? options.sidebarPath
+    : getVersionSidebarsPath(context.siteDir, options.id, versionName);
+
+  if (!(await fs.pathExists(contentPath))) {
+    throw new Error(
+      `The docs folder does not exist for version "${versionName}". A docs folder is expected to be found at ${path.relative(
+        context.siteDir,
+        contentPath,
+      )}.`,
+    );
+  }
+
+  // If the current version defines a path to a sidebar file that does not
+  // exist, we throw! Note: for versioned sidebars, the file may not exist (as
+  // we prefer to not create it rather than to create an empty file)
+  // See https://github.com/facebook/docusaurus/issues/3366
+  // See https://github.com/facebook/docusaurus/pull/4775
+  if (
+    versionName === CURRENT_VERSION_NAME &&
+    typeof sidebarFilePath === 'string' &&
+    !(await fs.pathExists(sidebarFilePath))
+  ) {
+    throw new Error(`The path to the sidebar file does not exist at "${path.relative(
+      context.siteDir,
+      sidebarFilePath,
+    )}".
+Please set the docs "sidebarPath" field in your config file to:
+- a sidebars path that exists
+- false: to disable the sidebar
+- undefined: for Docusaurus to generate it automatically`);
+  }
+
+  return {contentPath, contentPathLocalized, sidebarFilePath};
+}

package/src/versions/index.ts

@@ -0,0 +1,247 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import path from 'path';
+import {CURRENT_VERSION_NAME} from '../constants';
+import {normalizeUrl, posixPath} from '@docusaurus/utils';
+import {validateVersionsOptions} from './validation';
+import {
+  getDocsDirPathLocalized,
+  getVersionMetadataPaths,
+  readVersionNames,
+} from './files';
+import type {
+  PluginOptions,
+  VersionBanner,
+  VersionMetadata,
+} from '@docusaurus/plugin-content-docs';
+import type {LoadContext} from '@docusaurus/types';
+
+export type VersionContext = {
+  /** The version name to get banner of. */
+  versionName: string;
+  /** All versions, ordered from newest to oldest. */
+  versionNames: string[];
+  lastVersionName: string;
+  context: LoadContext;
+  options: PluginOptions;
+};
+
+function getVersionEditUrls({
+  contentPath,
+  contentPathLocalized,
+  context,
+  options,
+}: Pick<VersionMetadata, 'contentPath' | 'contentPathLocalized'> & {
+  context: LoadContext;
+  options: PluginOptions;
+}): Pick<VersionMetadata, 'editUrl' | 'editUrlLocalized'> {
+  // If the user is using the functional form of editUrl,
+  // she has total freedom and we can't compute a "version edit url"
+  if (!options.editUrl || typeof options.editUrl === 'function') {
+    return {editUrl: undefined, editUrlLocalized: undefined};
+  }
+
+  const editDirPath = options.editCurrentVersion ? options.path : contentPath;
+  const editDirPathLocalized = options.editCurrentVersion
+    ? getDocsDirPathLocalized({
+        siteDir: context.siteDir,
+        locale: context.i18n.currentLocale,
+        versionName: CURRENT_VERSION_NAME,
+        pluginId: options.id,
+      })
+    : contentPathLocalized;
+
+  const versionPathSegment = posixPath(
+    path.relative(context.siteDir, path.resolve(context.siteDir, editDirPath)),
+  );
+  const versionPathSegmentLocalized = posixPath(
+    path.relative(
+      context.siteDir,
+      path.resolve(context.siteDir, editDirPathLocalized),
+    ),
+  );
+
+  const editUrl = normalizeUrl([options.editUrl, versionPathSegment]);
+
+  const editUrlLocalized = normalizeUrl([
+    options.editUrl,
+    versionPathSegmentLocalized,
+  ]);
+
+  return {editUrl, editUrlLocalized};
+}
+
+/**
+ * The default version banner depends on the version's relative position to the
+ * latest version. More recent ones are "unreleased", and older ones are
+ * "unmaintained".
+ */
+export function getDefaultVersionBanner({
+  versionName,
+  versionNames,
+  lastVersionName,
+}: VersionContext): VersionBanner | null {
+  // Current version: good, no banner
+  if (versionName === lastVersionName) {
+    return null;
+  }
+  // Upcoming versions: unreleased banner
+  if (
+    versionNames.indexOf(versionName) < versionNames.indexOf(lastVersionName)
+  ) {
+    return 'unreleased';
+  }
+  // Older versions: display unmaintained banner
+  return 'unmaintained';
+}
+
+export function getVersionBanner(
+  context: VersionContext,
+): VersionMetadata['banner'] {
+  const {versionName, options} = context;
+  const versionBannerOption = options.versions[versionName]?.banner;
+  if (versionBannerOption) {
+    return versionBannerOption === 'none' ? null : versionBannerOption;
+  }
+  return getDefaultVersionBanner(context);
+}
+
+export function getVersionBadge({
+  versionName,
+  versionNames,
+  options,
+}: VersionContext): VersionMetadata['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 defaultVersionBadge = versionNames.length !== 1;
+  return options.versions[versionName]?.badge ?? defaultVersionBadge;
+}
+
+function getVersionClassName({
+  versionName,
+  options,
+}: VersionContext): VersionMetadata['className'] {
+  const defaultVersionClassName = `docs-version-${versionName}`;
+  return options.versions[versionName]?.className ?? defaultVersionClassName;
+}
+
+function getVersionLabel({
+  versionName,
+  options,
+}: VersionContext): VersionMetadata['label'] {
+  const defaultVersionLabel =
+    versionName === CURRENT_VERSION_NAME ? 'Next' : versionName;
+  return options.versions[versionName]?.label ?? defaultVersionLabel;
+}
+
+function getVersionPathPart({
+  versionName,
+  options,
+  lastVersionName,
+}: VersionContext): string {
+  function getDefaultVersionPathPart() {
+    if (versionName === lastVersionName) {
+      return '';
+    }
+    return versionName === CURRENT_VERSION_NAME ? 'next' : versionName;
+  }
+  return options.versions[versionName]?.path ?? getDefaultVersionPathPart();
+}
+
+async function createVersionMetadata(
+  context: VersionContext,
+): Promise<VersionMetadata> {
+  const {versionName, lastVersionName, options, context: loadContext} = context;
+  const {sidebarFilePath, contentPath, contentPathLocalized} =
+    await getVersionMetadataPaths(context);
+  const versionPathPart = getVersionPathPart(context);
+
+  const routePath = normalizeUrl([
+    loadContext.baseUrl,
+    options.routeBasePath,
+    versionPathPart,
+  ]);
+
+  const versionEditUrls = getVersionEditUrls({
+    contentPath,
+    contentPathLocalized,
+    context: loadContext,
+    options,
+  });
+
+  return {
+    versionName,
+    label: getVersionLabel(context),
+    banner: getVersionBanner(context),
+    badge: getVersionBadge(context),
+    className: getVersionClassName(context),
+    path: routePath,
+    tagsPath: normalizeUrl([routePath, options.tagsBasePath]),
+    ...versionEditUrls,
+    isLast: versionName === lastVersionName,
+    routePriority: versionPathPart === '' ? -1 : undefined,
+    sidebarFilePath,
+    contentPath,
+    contentPathLocalized,
+  };
+}
+
+/**
+ * Filter versions according to provided options (i.e. `onlyIncludeVersions`).
+ *
+ * Note: we preserve the order in which versions are provided; the order of the
+ * `onlyIncludeVersions` array does not matter
+ */
+export function filterVersions(
+  versionNamesUnfiltered: string[],
+  options: PluginOptions,
+): string[] {
+  if (options.onlyIncludeVersions) {
+    return versionNamesUnfiltered.filter((name) =>
+      options.onlyIncludeVersions!.includes(name),
+    );
+  }
+  return versionNamesUnfiltered;
+}
+
+function getLastVersionName({
+  versionNames,
+  options,
+}: Pick<VersionContext, 'versionNames' | 'options'>) {
+  return (
+    options.lastVersion ??
+    versionNames.find((name) => name !== CURRENT_VERSION_NAME) ??
+    CURRENT_VERSION_NAME
+  );
+}
+
+export async function readVersionsMetadata({
+  context,
+  options,
+}: {
+  context: LoadContext;
+  options: PluginOptions;
+}): Promise<VersionMetadata[]> {
+  const allVersionNames = await readVersionNames(context.siteDir, options);
+  validateVersionsOptions(allVersionNames, options);
+  const versionNames = filterVersions(allVersionNames, options);
+  const lastVersionName = getLastVersionName({versionNames, options});
+  const versionsMetadata = await Promise.all(
+    versionNames.map((versionName) =>
+      createVersionMetadata({
+        versionName,
+        versionNames,
+        lastVersionName,
+        context,
+        options,
+      }),
+    ),
+  );
+  return versionsMetadata;
+}