@docusaurus/plugin-content-docs 2.0.0-beta.ff31de0ff → 2.0.0-rc.1

package/src/types.ts

@@ -5,260 +5,43 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-// eslint-disable-next-line spaced-comment
-/// <reference types="@docusaurus/module-type-aliases" />
-
-import type {RemarkAndRehypePluginOptions} from '@docusaurus/mdx-loader';
-import {
-  BrokenMarkdownLink as IBrokenMarkdownLink,
-  ContentPaths,
-} from '@docusaurus/utils/lib/markdownLinks';
+import type {BrokenMarkdownLink, Tag} from '@docusaurus/utils';
+import type {
+  VersionMetadata,
+  LoadedVersion,
+  CategoryGeneratedIndexMetadata,
+} from '@docusaurus/plugin-content-docs';
+import type {SidebarsUtils} from './sidebars/utils';
 
 export type DocFile = {
   contentPath: string; // /!\ may be localized
   filePath: string; // /!\ may be localized
   source: string;
   content: string;
-  lastUpdate: LastUpdateData;
-};
-
-export type VersionName = string;
-
-export type VersionMetadata = ContentPaths & {
-  versionName: VersionName; // 1.0.0
-  versionLabel: string; // Version 1.0.0
-  versionPath: string; // /baseUrl/docs/1.0.0
-  versionEditUrl?: string | undefined;
-  versionEditUrlLocalized?: string | undefined;
-  isLast: boolean;
-  sidebarFilePath: string | false | undefined; // versioned_sidebars/1.0.0.json
-  routePriority: number | undefined; // -1 for the latest docs
-};
-
-export type EditUrlFunction = (editUrlParams: {
-  version: string;
-  versionDocsDirPath: string;
-  docPath: string;
-  permalink: string;
-  locale: string;
-}) => string | undefined;
-
-export type MetadataOptions = {
-  routeBasePath: string;
-  homePageId?: string;
-  editUrl?: string | EditUrlFunction;
-  editCurrentVersion: boolean;
-  editLocalizedFiles: boolean;
-  showLastUpdateTime?: boolean;
-  showLastUpdateAuthor?: boolean;
-  numberPrefixParser: NumberPrefixParser;
-};
-
-export type PathOptions = {
-  path: string;
-  sidebarPath?: string | false | undefined;
-};
-
-export type VersionOptions = {
-  path?: string;
-  label?: string;
-};
-
-export type VersionsOptions = {
-  lastVersion?: string;
-  versions: Record<string, VersionOptions>;
-  onlyIncludeVersions?: string[];
-};
-
-export type PluginOptions = MetadataOptions &
-  PathOptions &
-  VersionsOptions &
-  RemarkAndRehypePluginOptions & {
-    id: string;
-    include: string[];
-    docLayoutComponent: string;
-    docItemComponent: string;
-    admonitions: Record<string, unknown>;
-    disableVersioning: boolean;
-    excludeNextVersionDocs?: boolean;
-    includeCurrentVersion: boolean;
-    sidebarItemsGenerator: SidebarItemsGeneratorOption;
-  };
-
-export type SidebarItemBase = {
-  customProps?: Record<string, unknown>;
-};
-
-export type SidebarItemDoc = SidebarItemBase & {
-  type: 'doc' | 'ref';
-  label?: string;
-  id: string;
-};
-
-export type SidebarItemLink = SidebarItemBase & {
-  type: 'link';
-  href: string;
-  label: string;
-};
-
-export type SidebarItemCategory = SidebarItemBase & {
-  type: 'category';
-  label: string;
-  items: SidebarItem[];
-  collapsed: boolean;
-};
-
-export type UnprocessedSidebarItemAutogenerated = {
-  type: 'autogenerated';
-  dirName: string;
-};
-
-export type UnprocessedSidebarItemCategory = SidebarItemBase & {
-  type: 'category';
-  label: string;
-  items: UnprocessedSidebarItem[];
-  collapsed: boolean;
-};
-
-export type UnprocessedSidebarItem =
-  | SidebarItemDoc
-  | SidebarItemLink
-  | UnprocessedSidebarItemCategory
-  | UnprocessedSidebarItemAutogenerated;
-
-export type UnprocessedSidebar = UnprocessedSidebarItem[];
-export type UnprocessedSidebars = Record<string, UnprocessedSidebar>;
-
-export type SidebarItem =
-  | SidebarItemDoc
-  | SidebarItemLink
-  | SidebarItemCategory;
-
-export type Sidebar = SidebarItem[];
-export type SidebarItemType = SidebarItem['type'];
-export type Sidebars = Record<string, Sidebar>;
-
-// Reduce API surface for options.sidebarItemsGenerator
-// The user-provided generator fn should receive only a subset of metadatas
-// A change to any of these metadatas can be considered as a breaking change
-export type SidebarItemsGeneratorDoc = Pick<
-  DocMetadataBase,
-  'id' | 'frontMatter' | 'source' | 'sourceDirName' | 'sidebarPosition'
->;
-export type SidebarItemsGeneratorVersion = Pick<
-  VersionMetadata,
-  'versionName' | 'contentPath'
->;
-
-export type SidebarItemsGeneratorArgs = {
-  item: UnprocessedSidebarItemAutogenerated;
-  version: SidebarItemsGeneratorVersion;
-  docs: SidebarItemsGeneratorDoc[];
-  numberPrefixParser: NumberPrefixParser;
-};
-export type SidebarItemsGenerator = (
-  generatorArgs: SidebarItemsGeneratorArgs,
-) => Promise<SidebarItem[]>;
-
-// Also inject the default generator to conveniently wrap/enhance/sort the default sidebar gen logic
-// see https://github.com/facebook/docusaurus/issues/4640#issuecomment-822292320
-export type SidebarItemsGeneratorOptionArgs = {
-  defaultSidebarItemsGenerator: SidebarItemsGenerator;
-} & SidebarItemsGeneratorArgs;
-export type SidebarItemsGeneratorOption = (
-  generatorArgs: SidebarItemsGeneratorOptionArgs,
-) => Promise<SidebarItem[]>;
-
-export type OrderMetadata = {
-  previous?: string;
-  next?: string;
-  sidebar?: string;
-};
-
-export type LastUpdateData = {
-  lastUpdatedAt?: number;
-  formattedLastUpdatedAt?: string;
-  lastUpdatedBy?: string;
-};
-
-export type FrontMatter = {
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  [key: string]: any;
-};
-
-export type DocMetadataBase = LastUpdateData & {
-  version: VersionName;
-  unversionedId: string;
-  id: string;
-  isDocsHomePage: boolean;
-  title: string;
-  description: string;
-  source: string;
-  sourceDirName: string; // relative to the docs folder (can be ".")
-  slug: string;
-  permalink: string;
-  // eslint-disable-next-line camelcase
-  sidebar_label?: string;
-  sidebarPosition?: number;
-  editUrl?: string | null;
-  frontMatter: FrontMatter;
-};
-
-export type DocNavLink = {
-  title: string;
-  permalink: string;
-};
-
-export type DocMetadata = DocMetadataBase & {
-  sidebar?: string;
-  previous?: DocNavLink;
-  next?: DocNavLink;
 };
 
 export type SourceToPermalink = {
   [source: string]: string;
 };
-export type LoadedVersion = VersionMetadata & {
-  versionPath: string;
-  mainDocId: string;
-  docs: DocMetadata[];
-  sidebars: Sidebars;
-  permalinkToSidebar: Record<string, string>;
-};
-
-export type LoadedContent = {
-  loadedVersions: LoadedVersion[];
-};
 
-export type GlobalDoc = {
-  id: string;
-  path: string;
-  sidebar: string | undefined;
+export type VersionTag = Tag & {
+  /** All doc ids having this tag. */
+  docIds: string[];
 };
-
-export type GlobalVersion = {
-  name: VersionName;
-  label: string;
-  isLast: boolean;
-  path: string;
-  mainDocId: string; // home doc (if docs homepage configured), or first doc
-  docs: GlobalDoc[];
+export type VersionTags = {
+  [permalink: string]: VersionTag;
 };
 
-export type GlobalPluginData = {
-  path: string;
-  versions: GlobalVersion[];
+export type FullVersion = LoadedVersion & {
+  sidebarsUtils: SidebarsUtils;
+  categoryGeneratedIndices: CategoryGeneratedIndexMetadata[];
 };
 
-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;
 };
-
-export type NumberPrefixParser = (
-  filename: string,
-) => {filename: string; numberPrefix?: number};

package/src/versions/files.ts

@@ -0,0 +1,216 @@
+/**
+ * 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 {getPluginI18nPath, DEFAULT_PLUGIN_ID} from '@docusaurus/utils';
+import {
+  VERSIONS_JSON_FILE,
+  VERSIONED_DOCS_DIR,
+  VERSIONED_SIDEBARS_DIR,
+  CURRENT_VERSION_NAME,
+} from '../constants';
+import {validateVersionNames} from './validation';
+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({
+  localizationDir,
+  pluginId,
+  versionName,
+}: {
+  localizationDir: string;
+  pluginId: string;
+  versionName: string;
+}): string {
+  return getPluginI18nPath({
+    localizationDir,
+    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.
+ */
+export async function readVersionsFile(
+  siteDir: string,
+  pluginId: string,
+): Promise<string[] | null> {
+  const versionsFilePath = getVersionsFilePath(siteDir, pluginId);
+  if (await fs.pathExists(versionsFilePath)) {
+    const content: unknown = 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({
+    localizationDir: context.localizationDir,
+    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};
+}