@docusaurus/plugin-content-docs 0.0.0-4203 → 0.0.0-4207

package/lib/sidebars/utils.js

@@ -6,9 +6,13 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createSidebarsUtils = exports.collectSidebarsDocIds = exports.collectSidebarLinks = exports.collectSidebarCategories = exports.collectSidebarDocItems = exports.transformSidebarItems = void 0;
+exports.createSidebarsUtils = exports.collectSidebarsDocIds = exports.collectSidebarLinks = exports.collectSidebarCategories = exports.collectSidebarDocItems = exports.transformSidebarItems = exports.isCategoriesShorthand = void 0;
 const lodash_1 = require("lodash");
 const utils_1 = require("@docusaurus/utils");
+function isCategoriesShorthand(item) {
+    return typeof item !== 'string' && !item.type;
+}
+exports.isCategoriesShorthand = isCategoriesShorthand;
 function transformSidebarItems(sidebar, updateFn) {
     function transformRecursive(item) {
         if (item.type === 'category') {
@@ -43,9 +47,7 @@ function collectSidebarLinks(sidebar) {
 }
 exports.collectSidebarLinks = collectSidebarLinks;
 function collectSidebarsDocIds(sidebars) {
-    return (0, lodash_1.mapValues)(sidebars, (sidebar) => {
-        return collectSidebarDocItems(sidebar).map((docItem) => docItem.id);
-    });
+    return (0, lodash_1.mapValues)(sidebars, (sidebar) => collectSidebarDocItems(sidebar).map((docItem) => docItem.id));
 }
 exports.collectSidebarsDocIds = collectSidebarsDocIds;
 function createSidebarsUtils(sidebars) {

package/lib/sidebars/validation.d.ts

@@ -4,5 +4,5 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { SidebarsConfig } from './types';
+import type { SidebarsConfig } from './types';
 export declare function validateSidebars(sidebars: unknown): asserts sidebars is SidebarsConfig;

package/lib/sidebars/validation.js

@@ -8,7 +8,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateSidebars = void 0;
 const utils_validation_1 = require("@docusaurus/utils-validation");
-const types_1 = require("./types");
+const utils_1 = require("./utils");
 const sidebarItemBaseSchema = utils_validation_1.Joi.object({
     className: utils_validation_1.Joi.string(),
     customProps: utils_validation_1.Joi.object().unknown(),
@@ -79,7 +79,7 @@ function validateSidebarItem(item) {
     }
     // TODO: remove once with proper Joi support
     // Because we can't use Joi to validate nested items (see above), we do it manually
-    if ((0, types_1.isCategoriesShorthand)(item)) {
+    if ((0, utils_1.isCategoriesShorthand)(item)) {
         Object.values(item).forEach((category) => category.forEach(validateSidebarItem));
     }
     else {

package/lib/slug.d.ts

@@ -4,7 +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 { NumberPrefixParser } from './types';
+import type { NumberPrefixParser } from './types';
 export default function getSlug({ baseID, frontmatterSlug, dirName, stripDirNumberPrefixes, numberPrefixParser, }: {
     baseID: string;
     frontmatterSlug?: string;

package/lib/tags.d.ts

@@ -4,5 +4,5 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { VersionTags, DocMetadata } from './types';
+import type { VersionTags, DocMetadata } from './types';
 export declare function getVersionTags(docs: DocMetadata[]): VersionTags;

package/lib/tags.js

@@ -11,12 +11,10 @@ const utils_1 = require("@docusaurus/utils");
 const lodash_1 = require("lodash");
 function getVersionTags(docs) {
     const groups = (0, utils_1.groupTaggedItems)(docs, (doc) => doc.tags);
-    return (0, lodash_1.mapValues)(groups, (group) => {
-        return {
-            name: group.tag.label,
-            docIds: group.items.map((item) => item.id),
-            permalink: group.tag.permalink,
-        };
-    });
+    return (0, lodash_1.mapValues)(groups, (group) => ({
+        name: group.tag.label,
+        docIds: group.items.map((item) => item.id),
+        permalink: group.tag.permalink,
+    }));
 }
 exports.getVersionTags = getVersionTags;

package/lib/translations.d.ts

@@ -5,6 +5,6 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { LoadedContent } from './types';
-import { TranslationFile, TranslationFiles } from '@docusaurus/types';
+import type { TranslationFile, TranslationFiles } from '@docusaurus/types';
 export declare function getLoadedContentTranslationFiles(loadedContent: LoadedContent): TranslationFiles;
 export declare function translateLoadedContent(loadedContent: LoadedContent, translationFiles: TranslationFile[]): LoadedContent;

package/lib/translations.js

@@ -120,16 +120,14 @@ function getSidebarsTranslations(version) {
     }));
 }
 function translateSidebars(version, sidebarsTranslations) {
-    return (0, lodash_1.mapValues)(version.sidebars, (sidebar, sidebarName) => {
-        return translateSidebar({
-            sidebar,
-            sidebarName: getNormalizedSidebarName({
-                sidebarName,
-                versionName: version.versionName,
-            }),
-            sidebarsTranslations,
-        });
-    });
+    return (0, lodash_1.mapValues)(version.sidebars, (sidebar, sidebarName) => translateSidebar({
+        sidebar,
+        sidebarName: getNormalizedSidebarName({
+            sidebarName,
+            versionName: version.versionName,
+        }),
+        sidebarsTranslations,
+    }));
 }
 function getVersionTranslationFiles(version) {
     const versionTranslations = {

package/lib/versions.d.ts

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { PluginOptions, VersionMetadata } from './types';
-import { LoadContext } from '@docusaurus/types';
+import type { PluginOptions, VersionMetadata } from './types';
+import type { LoadContext } from '@docusaurus/types';
 export declare function getVersionedDocsDirPath(siteDir: string, pluginId: string): string;
 export declare function getVersionedSidebarsDirPath(siteDir: string, pluginId: string): string;
 export declare function getVersionsFilePath(siteDir: string, pluginId: string): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "0.0.0-4203",
+  "version": "0.0.0-4207",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-docs.d.ts",
@@ -18,7 +18,7 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4203",
+    "@docusaurus/module-type-aliases": "0.0.0-4207",
     "@types/js-yaml": "^4.0.0",
     "@types/picomatch": "^2.2.1",
     "commander": "^5.1.0",
@@ -26,11 +26,11 @@
     "utility-types": "^3.10.0"
   },
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4203",
-    "@docusaurus/mdx-loader": "0.0.0-4203",
-    "@docusaurus/types": "0.0.0-4203",
-    "@docusaurus/utils": "0.0.0-4203",
-    "@docusaurus/utils-validation": "0.0.0-4203",
+    "@docusaurus/core": "0.0.0-4207",
+    "@docusaurus/mdx-loader": "0.0.0-4207",
+    "@docusaurus/types": "0.0.0-4207",
+    "@docusaurus/utils": "0.0.0-4207",
+    "@docusaurus/utils-validation": "0.0.0-4207",
     "chalk": "^4.1.2",
     "combine-promises": "^1.1.0",
     "escape-string-regexp": "^4.0.0",
@@ -53,5 +53,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "c593f92915e118d87c10015d5db2c42eda4b5ef3"
+  "gitHead": "63059ec789f63c76514839ed417d2ef58456666e"
 }

package/src/__tests__/docs.test.ts

@@ -15,7 +15,7 @@ import {
 } from '../docs';
 import {loadSidebars} from '../sidebars';
 import {readVersionsMetadata} from '../versions';
-import {
+import type {
   DocFile,
   DocMetadataBase,
   MetadataOptions,
@@ -24,7 +24,7 @@ import {
   EditUrlFunction,
   DocNavLink,
 } from '../types';
-import {LoadContext} from '@docusaurus/types';
+import type {LoadContext} from '@docusaurus/types';
 import {DEFAULT_PLUGIN_ID} from '@docusaurus/core/lib/constants';
 import {DEFAULT_OPTIONS} from '../options';
 import {Optional} from 'utility-types';

package/src/__tests__/index.test.ts

@@ -14,7 +14,7 @@ import fs from 'fs-extra';
 import pluginContentDocs from '../index';
 import {loadContext} from '@docusaurus/core/src/server/index';
 import {applyConfigureWebpack} from '@docusaurus/core/src/webpack/utils';
-import {RouteConfig} from '@docusaurus/types';
+import type {RouteConfig} from '@docusaurus/types';
 import {posixPath} from '@docusaurus/utils';
 import {sortConfig} from '@docusaurus/core/src/server/plugins';
 import {DEFAULT_PLUGIN_ID} from '@docusaurus/core/lib/constants';

package/src/__tests__/versions.test.ts

@@ -15,7 +15,7 @@ import {
 import {DEFAULT_OPTIONS} from '../options';
 import {DEFAULT_PLUGIN_ID} from '@docusaurus/core/lib/constants';
 import {PluginOptions, VersionMetadata} from '../types';
-import {I18n} from '@docusaurus/types';
+import type {I18n} from '@docusaurus/types';
 
 const DefaultI18N: I18n = {
   currentLocale: 'en',
@@ -600,11 +600,9 @@ describe('versioned site, pluginId=default', () => {
   test('readVersionsMetadata versioned site with invalid versions.json file', async () => {
     const {defaultOptions, defaultContext} = await loadSite();
 
-    const mock = jest.spyOn(JSON, 'parse').mockImplementationOnce(() => {
-      return {
-        invalid: 'json',
-      };
-    });
+    const mock = jest.spyOn(JSON, 'parse').mockImplementationOnce(() => ({
+      invalid: 'json',
+    }));
 
     expect(() => {
       readVersionsMetadata({

package/src/client/docsClientUtils.ts

@@ -31,13 +31,12 @@ export function getActivePlugin(
   options: GetActivePluginOptions = {},
 ): ActivePlugin | undefined {
   const activeEntry = Object.entries(allPluginDatas).find(
-    ([_id, pluginData]) => {
-      return !!matchPath(pathname, {
+    ([_id, pluginData]) =>
+      !!matchPath(pathname, {
         path: pluginData.path,
         exact: false,
         strict: false,
-      });
-    },
+      }),
   );
 
   const activePlugin: ActivePlugin | undefined = activeEntry
@@ -63,9 +62,8 @@ export type ActiveDocContext = {
   alternateDocVersions: Record<string, Doc>;
 };
 
-export const getLatestVersion = (data: GlobalPluginData): Version => {
-  return data.versions.find((version) => version.isLast)!;
-};
+export const getLatestVersion = (data: GlobalPluginData): Version =>
+  data.versions.find((version) => version.isLast)!;
 
 // Note: return undefined on doc-unrelated pages,
 // because there's no version currently considered as active
@@ -80,13 +78,14 @@ export const getActiveVersion = (
     ...data.versions.filter((version) => version !== lastVersion),
     lastVersion,
   ];
-  return orderedVersionsMetadata.find((version) => {
-    return !!matchPath(pathname, {
-      path: version.path,
-      exact: false,
-      strict: false,
-    });
-  });
+  return orderedVersionsMetadata.find(
+    (version) =>
+      !!matchPath(pathname, {
+        path: version.path,
+        exact: false,
+        strict: false,
+      }),
+  );
 };
 
 export const getActiveDocContext = (

package/src/docFrontMatter.ts

@@ -12,7 +12,7 @@ import {
   FrontMatterTOCHeadingLevels,
   validateFrontMatter,
 } from '@docusaurus/utils-validation';
-import {DocFrontMatter} from './types';
+import type {DocFrontMatter} from './types';
 
 // NOTE: we don't add any default value on purpose here
 // We don't want default values to magically appear in doc metadata and props

package/src/docs.ts

@@ -19,7 +19,7 @@ import {
   Globby,
   normalizeFrontMatterTags,
 } from '@docusaurus/utils';
-import {LoadContext} from '@docusaurus/types';
+import type {LoadContext} from '@docusaurus/types';
 
 import {getFileLastUpdate} from './lastUpdate';
 import {

package/src/globalData.ts

@@ -5,7 +5,12 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {DocMetadata, GlobalDoc, LoadedVersion, GlobalVersion} from './types';
+import type {
+  DocMetadata,
+  GlobalDoc,
+  LoadedVersion,
+  GlobalVersion,
+} from './types';
 
 export function toGlobalDataDoc(doc: DocMetadata): GlobalDoc {
   return {

package/src/index.ts

@@ -20,7 +20,7 @@ import {
   addTrailingPathSeparator,
   createAbsoluteFilePathMatcher,
 } from '@docusaurus/utils';
-import {LoadContext, Plugin, RouteConfig} from '@docusaurus/types';
+import type {LoadContext, Plugin, RouteConfig} from '@docusaurus/types';
 import {loadSidebars} from './sidebars';
 import {CategoryMetadataFilenamePattern} from './sidebars/generator';
 import {readVersionDocs, processDocMetadata, handleNavigation} from './docs';
@@ -39,7 +39,7 @@ import {
   DocsMarkdownOption,
   VersionTag,
 } from './types';
-import {RuleSetRule} from 'webpack';
+import type {RuleSetRule} from 'webpack';
 import {cliDocsVersionCommand} from './cli';
 import {VERSIONS_JSON_FILE} from './constants';
 import {keyBy, mapValues} from 'lodash';

package/src/numberPrefix.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {NumberPrefixParser} from './types';
+import type {NumberPrefixParser} from './types';
 
 // Best-effort to avoid parsing some patterns as number prefix
 const IgnoredPrefixPatterns = (function () {

package/src/options.ts

@@ -4,7 +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 {PluginOptions} from './types';
+import type {PluginOptions} from './types';
 import {
   Joi,
   RemarkPluginsSchema,
@@ -14,7 +14,10 @@ import {
 } from '@docusaurus/utils-validation';
 import {GlobExcludeDefault} from '@docusaurus/utils';
 
-import {OptionValidationContext, ValidationResult} from '@docusaurus/types';
+import type {
+  OptionValidationContext,
+  ValidationResult,
+} from '@docusaurus/types';
 import chalk from 'chalk';
 import admonitions from 'remark-admonitions';
 import {DefaultSidebarItemsGenerator} from './sidebars/generator';

package/src/plugin-content-docs.d.ts

@@ -70,12 +70,10 @@ declare module '@theme/DocItem' {
     readonly title: string;
     readonly image?: string;
     readonly keywords?: readonly string[];
-    /* eslint-disable camelcase */
     readonly hide_title?: boolean;
     readonly hide_table_of_contents?: boolean;
     readonly toc_min_heading_level?: number;
     readonly toc_max_heading_level?: number;
-    /* eslint-enable camelcase */
   };
 
   export type Metadata = {

package/src/props.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {LoadedVersion, VersionTag, DocMetadata} from './types';
+import type {LoadedVersion, VersionTag, DocMetadata} from './types';
 import type {
   SidebarItemDoc,
   SidebarItemLink,

package/src/sidebars/__tests__/generator.test.ts

@@ -36,14 +36,16 @@ describe('DefaultSidebarItemsGenerator', () => {
   function mockCategoryMetadataFiles(
     categoryMetadataFiles: Record<string, Partial<CategoryMetadataFile>>,
   ) {
-    jest.spyOn(fs, 'pathExists').mockImplementation((metadataFilePath) => {
-      return typeof categoryMetadataFiles[metadataFilePath] !== 'undefined';
-    });
+    jest
+      .spyOn(fs, 'pathExists')
+      .mockImplementation(
+        (metadataFilePath) =>
+          typeof categoryMetadataFiles[metadataFilePath] !== 'undefined',
+      );
     jest.spyOn(fs, 'readFile').mockImplementation(
       // @ts-expect-error: annoying TS error due to overrides
-      async (metadataFilePath: string) => {
-        return JSON.stringify(categoryMetadataFiles[metadataFilePath]);
-      },
+      async (metadataFilePath: string) =>
+        JSON.stringify(categoryMetadataFiles[metadataFilePath]),
     );
   }
 

package/src/sidebars/__tests__/processor.test.ts

@@ -21,9 +21,7 @@ describe('processSidebars', () => {
   ];
 
   const StaticSidebarItemsGenerator: SidebarItemsGenerator = jest.fn(
-    async () => {
-      return StaticGeneratedSidebarSlice;
-    },
+    async () => StaticGeneratedSidebarSlice,
   );
 
   async function testProcessSidebars(unprocessedSidebars: NormalizedSidebars) {

package/src/sidebars/normalization.ts

@@ -6,7 +6,7 @@
  */
 
 import type {SidebarOptions} from '../types';
-import {
+import type {
   NormalizedSidebarItem,
   NormalizedSidebar,
   NormalizedSidebars,
@@ -15,9 +15,9 @@ import {
   SidebarItemConfig,
   SidebarConfig,
   SidebarsConfig,
-  isCategoriesShorthand,
 } from './types';
 import {mapValues} from 'lodash';
+import {isCategoriesShorthand} from './utils';
 
 function normalizeCategoriesShorthand(
   sidebar: SidebarCategoriesShorthand,

package/src/sidebars/types.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {Optional} from 'utility-types';
+import type {Optional} from 'utility-types';
 import type {
   DocMetadataBase,
   VersionMetadata,
@@ -56,12 +56,6 @@ export type SidebarCategoriesShorthand = {
   [sidebarCategory: string]: SidebarItemConfig[];
 };
 
-export function isCategoriesShorthand(
-  item: SidebarItemConfig,
-): item is SidebarCategoriesShorthand {
-  return typeof item !== 'string' && !item.type;
-}
-
 export type SidebarItemConfig =
   | SidebarItemDoc
   | SidebarItemLink

package/src/sidebars/utils.ts

@@ -13,10 +13,18 @@ import type {
   SidebarItemLink,
   SidebarItemDoc,
   SidebarItemType,
+  SidebarCategoriesShorthand,
+  SidebarItemConfig,
 } from './types';
 import {mapValues, difference} from 'lodash';
 import {getElementsAround, toMessageRelativeFilePath} from '@docusaurus/utils';
 
+export function isCategoriesShorthand(
+  item: SidebarItemConfig,
+): item is SidebarCategoriesShorthand {
+  return typeof item !== 'string' && !item.type;
+}
+
 export function transformSidebarItems(
   sidebar: Sidebar,
   updateFn: (item: SidebarItem) => SidebarItem,
@@ -65,9 +73,9 @@ export function collectSidebarLinks(sidebar: Sidebar): SidebarItemLink[] {
 export function collectSidebarsDocIds(
   sidebars: Sidebars,
 ): Record<string, string[]> {
-  return mapValues(sidebars, (sidebar) => {
-    return collectSidebarDocItems(sidebar).map((docItem) => docItem.id);
-  });
+  return mapValues(sidebars, (sidebar) =>
+    collectSidebarDocItems(sidebar).map((docItem) => docItem.id),
+  );
 }
 
 export function createSidebarsUtils(sidebars: Sidebars): {

package/src/sidebars/validation.ts

@@ -6,7 +6,7 @@
  */
 
 import {Joi, URISchema} from '@docusaurus/utils-validation';
-import {
+import type {
   SidebarItemConfig,
   SidebarCategoriesShorthand,
   SidebarItemBase,
@@ -15,8 +15,8 @@ import {
   SidebarItemLink,
   SidebarItemCategoryConfig,
   SidebarsConfig,
-  isCategoriesShorthand,
 } from './types';
+import {isCategoriesShorthand} from './utils';
 
 const sidebarItemBaseSchema = Joi.object<SidebarItemBase>({
   className: Joi.string(),

package/src/slug.ts

@@ -15,7 +15,7 @@ import {
   DefaultNumberPrefixParser,
   stripPathNumberPrefixes,
 } from './numberPrefix';
-import {NumberPrefixParser} from './types';
+import type {NumberPrefixParser} from './types';
 
 export default function getSlug({
   baseID,

package/src/tags.ts

@@ -6,16 +6,14 @@
  */
 
 import {groupTaggedItems} from '@docusaurus/utils';
-import {VersionTags, DocMetadata} from './types';
+import type {VersionTags, DocMetadata} from './types';
 import {mapValues} from 'lodash';
 
 export function getVersionTags(docs: DocMetadata[]): VersionTags {
   const groups = groupTaggedItems(docs, (doc) => doc.tags);
-  return mapValues(groups, (group) => {
-    return {
-      name: group.tag.label,
-      docIds: group.items.map((item) => item.id),
-      permalink: group.tag.permalink,
-    };
-  });
+  return mapValues(groups, (group) => ({
+    name: group.tag.label,
+    docIds: group.items.map((item) => item.id),
+    permalink: group.tag.permalink,
+  }));
 }

package/src/translations.ts

@@ -14,7 +14,7 @@ import {
   transformSidebarItems,
   collectSidebarLinks,
 } from './sidebars/utils';
-import {
+import type {
   TranslationFileContent,
   TranslationFile,
   TranslationFiles,
@@ -164,16 +164,16 @@ function translateSidebars(
   version: LoadedVersion,
   sidebarsTranslations: TranslationFileContent,
 ): Sidebars {
-  return mapValues(version.sidebars, (sidebar, sidebarName) => {
-    return translateSidebar({
+  return mapValues(version.sidebars, (sidebar, sidebarName) =>
+    translateSidebar({
       sidebar,
       sidebarName: getNormalizedSidebarName({
         sidebarName,
         versionName: version.versionName,
       }),
       sidebarsTranslations,
-    });
-  });
+    }),
+  );
 }
 
 function getVersionTranslationFiles(version: LoadedVersion): TranslationFiles {

package/src/types.ts

@@ -113,7 +113,6 @@ export type LastUpdateData = {
 
 export type DocFrontMatter = {
   // Front matter uses snake case
-  /* eslint-disable camelcase */
   id?: string;
   title?: string;
   tags?: FrontMatterTag[];
@@ -133,7 +132,6 @@ export type DocFrontMatter = {
   toc_max_heading_level?: number;
   pagination_next?: string | null;
   pagination_prev?: string | null;
-  /* eslint-enable camelcase */
 };
 
 export type DocMetadataBase = LastUpdateData & {

package/src/versions.ts

@@ -7,7 +7,7 @@
 
 import path from 'path';
 import fs from 'fs-extra';
-import {
+import type {
   PluginOptions,
   VersionBanner,
   VersionMetadata,
@@ -22,7 +22,7 @@ import {
 } from './constants';
 
 import {DEFAULT_PLUGIN_ID} from '@docusaurus/core/lib/constants';
-import {LoadContext} from '@docusaurus/types';
+import type {LoadContext} from '@docusaurus/types';
 import {getPluginI18nPath, normalizeUrl, posixPath} from '@docusaurus/utils';
 import {difference} from 'lodash';
 import {resolveSidebarPathOption} from './sidebars';