@docusaurus/plugin-content-docs 2.0.0-beta.2 → 2.0.0-beta.20

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;
+}

package/src/versions/validation.ts

@@ -0,0 +1,113 @@
+/**
+ * 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 _ from 'lodash';
+import type {VersionsOptions} from '@docusaurus/plugin-content-docs';
+
+export function validateVersionName(name: unknown): asserts name is string {
+  if (typeof name !== 'string') {
+    throw new Error(
+      `Versions should be strings. Found type "${typeof name}" for version "${name}".`,
+    );
+  }
+  if (!name.trim()) {
+    throw new Error(
+      `Invalid version name "${name}": version name must contain at least one non-whitespace character.`,
+    );
+  }
+  const errors: [RegExp, string][] = [
+    [/[/\\]/, 'should not include slash (/) or backslash (\\)'],
+    [/.{33,}/, 'cannot be longer than 32 characters'],
+    // eslint-disable-next-line no-control-regex
+    [/[<>:"|?*\x00-\x1F]/, 'should be a valid file path'],
+    [/^\.\.?$/, 'should not be "." or ".."'],
+  ];
+
+  errors.forEach(([pattern, message]) => {
+    if (pattern.test(name)) {
+      throw new Error(
+        `Invalid version name "${name}": version name ${message}.`,
+      );
+    }
+  });
+}
+
+export function validateVersionNames(
+  names: unknown,
+): asserts names is string[] {
+  if (!Array.isArray(names)) {
+    throw new Error(
+      `The versions file should contain an array of version names! Found content: ${JSON.stringify(
+        names,
+      )}`,
+    );
+  }
+
+  names.forEach(validateVersionName);
+}
+
+/**
+ * @throws Throws for one of the following invalid options:
+ * - `lastVersion` is non-existent
+ * - `versions` includes unknown keys
+ * - `onlyIncludeVersions` is empty, contains unknown names, or doesn't include
+ * `latestVersion` (if provided)
+ */
+export function validateVersionsOptions(
+  availableVersionNames: string[],
+  options: VersionsOptions,
+): void {
+  const availableVersionNamesMsg = `Available version names are: ${availableVersionNames.join(
+    ', ',
+  )}`;
+  if (
+    options.lastVersion &&
+    !availableVersionNames.includes(options.lastVersion)
+  ) {
+    throw new Error(
+      `Docs option lastVersion: ${options.lastVersion} is invalid. ${availableVersionNamesMsg}`,
+    );
+  }
+  const unknownVersionConfigNames = _.difference(
+    Object.keys(options.versions),
+    availableVersionNames,
+  );
+  if (unknownVersionConfigNames.length > 0) {
+    throw new Error(
+      `Invalid docs option "versions": unknown versions (${unknownVersionConfigNames.join(
+        ',',
+      )}) found. ${availableVersionNamesMsg}`,
+    );
+  }
+
+  if (options.onlyIncludeVersions) {
+    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 = _.difference(
+      options.onlyIncludeVersions,
+      availableVersionNames,
+    );
+    if (unknownOnlyIncludeVersionNames.length > 0) {
+      throw new Error(
+        `Invalid docs option "onlyIncludeVersions": unknown versions (${unknownOnlyIncludeVersionNames.join(
+          ',',
+        )}) found. ${availableVersionNamesMsg}`,
+      );
+    }
+    if (
+      options.lastVersion &&
+      !options.onlyIncludeVersions.includes(options.lastVersion)
+    ) {
+      throw new Error(
+        `Invalid docs option "lastVersion": if you use both the "onlyIncludeVersions" and "lastVersion" options, then "lastVersion" must be present in the provided "onlyIncludeVersions" array.`,
+      );
+    }
+  }
+}