@docusaurus/plugin-content-docs 0.0.0-4561 → 0.0.0-4566

package/lib/docFrontMatter.js

@@ -24,6 +24,7 @@ const DocFrontMatterSchema = utils_validation_1.JoiFrontMatter.object({
     sidebar_label: utils_validation_1.JoiFrontMatter.string(),
     sidebar_position: utils_validation_1.JoiFrontMatter.number(),
     sidebar_class_name: utils_validation_1.JoiFrontMatter.string(),
+    sidebar_custom_props: utils_validation_1.JoiFrontMatter.object().unknown(),
     displayed_sidebar: utils_validation_1.JoiFrontMatter.string().allow(null),
     tags: utils_validation_1.FrontMatterTagsSchema,
     pagination_label: utils_validation_1.JoiFrontMatter.string(),

package/lib/lastUpdate.js

@@ -8,52 +8,31 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getFileLastUpdate = void 0;
 const tslib_1 = require("tslib");
-const shelljs_1 = (0, tslib_1.__importDefault)(require("shelljs"));
 const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
-const path_1 = (0, tslib_1.__importDefault)(require("path"));
-const GIT_COMMIT_TIMESTAMP_AUTHOR_REGEX = /^(?<timestamp>\d+),(?<author>.+)$/;
+const utils_1 = require("@docusaurus/utils");
 let showedGitRequirementError = false;
 async function getFileLastUpdate(filePath) {
     if (!filePath) {
         return null;
     }
-    function getTimestampAndAuthor(str) {
-        var _a;
-        if (!str) {
-            return null;
-        }
-        const temp = (_a = str.match(GIT_COMMIT_TIMESTAMP_AUTHOR_REGEX)) === null || _a === void 0 ? void 0 : _a.groups;
-        return temp
-            ? { timestamp: Number(temp.timestamp), author: temp.author }
-            : null;
-    }
     // Wrap in try/catch in case the shell commands fail
     // (e.g. project doesn't use Git, etc).
     try {
-        if (!shelljs_1.default.which('git')) {
-            if (!showedGitRequirementError) {
-                showedGitRequirementError = true;
-                logger_1.default.warn('Sorry, the docs plugin last update options require Git.');
-            }
-            return null;
-        }
-        if (!shelljs_1.default.test('-f', filePath)) {
-            throw new Error(`Retrieval of git history failed at "${filePath}" because the file does not exist.`);
-        }
-        const fileBasename = path_1.default.basename(filePath);
-        const fileDirname = path_1.default.dirname(filePath);
-        const result = shelljs_1.default.exec(`git log --max-count=1 --format=%ct,%an -- "${fileBasename}"`, {
-            cwd: fileDirname,
-            silent: true,
+        const result = (0, utils_1.getFileCommitDate)(filePath, {
+            age: 'newest',
+            includeAuthor: true,
         });
-        if (result.code !== 0) {
-            throw new Error(`Retrieval of git history failed at "${filePath}" with exit code ${result.code}: ${result.stderr}`);
-        }
-        return getTimestampAndAuthor(result.stdout.trim());
+        return { timestamp: result.timestamp, author: result.author };
     }
     catch (e) {
-        logger_1.default.error(e);
+        if (e instanceof utils_1.GitNotFoundError && !showedGitRequirementError) {
+            logger_1.default.warn('Sorry, the docs plugin last update options require Git.');
+            showedGitRequirementError = true;
+        }
+        else {
+            logger_1.default.error(e);
+        }
+        return null;
     }
-    return null;
 }
 exports.getFileLastUpdate = getFileLastUpdate;

package/lib/props.js

@@ -21,6 +21,7 @@ Available document ids are:
         return docMetadata;
     }
     const convertDocLink = (item) => {
+        var _a;
         const docMetadata = getDocById(item.id);
         const { title, permalink, frontMatter: { sidebar_label: sidebarLabel }, } = docMetadata;
         return {
@@ -28,7 +29,7 @@ Available document ids are:
             label: sidebarLabel || item.label || title,
             href: permalink,
             className: item.className,
-            customProps: item.customProps,
+            customProps: (_a = item.customProps) !== null && _a !== void 0 ? _a : docMetadata.frontMatter.sidebar_custom_props,
             docId: docMetadata.unversionedId,
         };
     };

package/lib/types.d.ts

@@ -47,6 +47,7 @@ export declare type DocFrontMatter = {
     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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "0.0.0-4561",
+  "version": "0.0.0-4566",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "exports": {
@@ -23,30 +23,30 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4561",
-    "@docusaurus/logger": "0.0.0-4561",
-    "@docusaurus/mdx-loader": "0.0.0-4561",
-    "@docusaurus/utils": "0.0.0-4561",
-    "@docusaurus/utils-validation": "0.0.0-4561",
+    "@docusaurus/core": "0.0.0-4566",
+    "@docusaurus/logger": "0.0.0-4566",
+    "@docusaurus/mdx-loader": "0.0.0-4566",
+    "@docusaurus/utils": "0.0.0-4566",
+    "@docusaurus/utils-validation": "0.0.0-4566",
     "combine-promises": "^1.1.0",
     "fs-extra": "^10.0.0",
     "import-fresh": "^3.2.2",
     "js-yaml": "^4.0.0",
     "lodash": "^4.17.20",
     "remark-admonitions": "^1.2.1",
-    "shelljs": "^0.8.4",
     "tslib": "^2.3.1",
     "utility-types": "^3.10.0",
     "webpack": "^5.68.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4561",
-    "@docusaurus/types": "0.0.0-4561",
+    "@docusaurus/module-type-aliases": "0.0.0-4566",
+    "@docusaurus/types": "0.0.0-4566",
     "@types/js-yaml": "^4.0.0",
     "@types/picomatch": "^2.2.1",
     "commander": "^5.1.0",
     "escape-string-regexp": "^4.0.0",
     "picomatch": "^2.1.1",
+    "shelljs": "^0.8.4",
     "utility-types": "^3.10.0"
   },
   "peerDependencies": {
@@ -56,5 +56,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "d3f1df862e0e65e8427f9ed6e09e80eac7aff3cd"
+  "gitHead": "9f29e9998cf84adba25ceabd263fb637537d0033"
 }

package/src/docFrontMatter.ts

@@ -30,6 +30,7 @@ const DocFrontMatterSchema = Joi.object<DocFrontMatter>({
   sidebar_label: Joi.string(),
   sidebar_position: Joi.number(),
   sidebar_class_name: Joi.string(),
+  sidebar_custom_props: Joi.object().unknown(),
   displayed_sidebar: Joi.string().allow(null),
   tags: FrontMatterTagsSchema,
   pagination_label: Joi.string(),

package/src/lastUpdate.ts

@@ -5,14 +5,11 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import shell from 'shelljs';
 import logger from '@docusaurus/logger';
-import path from 'path';
+import {getFileCommitDate, GitNotFoundError} from '@docusaurus/utils';
 
 type FileLastUpdateData = {timestamp?: number; author?: string};
 
-const GIT_COMMIT_TIMESTAMP_AUTHOR_REGEX = /^(?<timestamp>\d+),(?<author>.+)$/;
-
 let showedGitRequirementError = false;
 
 export async function getFileLastUpdate(
@@ -21,53 +18,22 @@ export async function getFileLastUpdate(
   if (!filePath) {
     return null;
   }
-  function getTimestampAndAuthor(str: string): FileLastUpdateData | null {
-    if (!str) {
-      return null;
-    }
-
-    const temp = str.match(GIT_COMMIT_TIMESTAMP_AUTHOR_REGEX)?.groups;
-    return temp
-      ? {timestamp: Number(temp.timestamp), author: temp.author}
-      : null;
-  }
 
   // Wrap in try/catch in case the shell commands fail
   // (e.g. project doesn't use Git, etc).
   try {
-    if (!shell.which('git')) {
-      if (!showedGitRequirementError) {
-        showedGitRequirementError = true;
-        logger.warn('Sorry, the docs plugin last update options require Git.');
-      }
-
-      return null;
-    }
-
-    if (!shell.test('-f', filePath)) {
-      throw new Error(
-        `Retrieval of git history failed at "${filePath}" because the file does not exist.`,
-      );
-    }
-
-    const fileBasename = path.basename(filePath);
-    const fileDirname = path.dirname(filePath);
-    const result = shell.exec(
-      `git log --max-count=1 --format=%ct,%an -- "${fileBasename}"`,
-      {
-        cwd: fileDirname, // this is needed: https://github.com/facebook/docusaurus/pull/5048
-        silent: true,
-      },
-    );
-    if (result.code !== 0) {
-      throw new Error(
-        `Retrieval of git history failed at "${filePath}" with exit code ${result.code}: ${result.stderr}`,
-      );
-    }
-    return getTimestampAndAuthor(result.stdout.trim());
+    const result = getFileCommitDate(filePath, {
+      age: 'newest',
+      includeAuthor: true,
+    });
+    return {timestamp: result.timestamp, author: result.author};
   } catch (e) {
-    logger.error(e);
+    if (e instanceof GitNotFoundError && !showedGitRequirementError) {
+      logger.warn('Sorry, the docs plugin last update options require Git.');
+      showedGitRequirementError = true;
+    } else {
+      logger.error(e);
+    }
+    return null;
   }
-
-  return null;
 }

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

@@ -209,26 +209,6 @@ declare module '@theme/DocItem' {
   export default DocItem;
 }
 
-declare module '@theme/DocCard' {
-  import type {PropSidebarItem} from '@docusaurus/plugin-content-docs';
-
-  export interface Props {
-    readonly item: PropSidebarItem;
-  }
-
-  export default function DocCard(props: Props): JSX.Element;
-}
-
-declare module '@theme/DocCardList' {
-  import type {PropSidebarItem} from '@docusaurus/plugin-content-docs';
-
-  export interface Props {
-    readonly items: PropSidebarItem[];
-  }
-
-  export default function DocCardList(props: Props): JSX.Element;
-}
-
 declare module '@theme/DocCategoryGeneratedIndexPage' {
   import type {PropCategoryGeneratedIndex} from '@docusaurus/plugin-content-docs';
 
@@ -241,12 +221,6 @@ declare module '@theme/DocCategoryGeneratedIndexPage' {
   ): JSX.Element;
 }
 
-declare module '@theme/DocItemFooter' {
-  import type {Props} from '@theme/DocItem';
-
-  export default function DocItemFooter(props: Props): JSX.Element;
-}
-
 declare module '@theme/DocTagsListPage' {
   import type {PropTagsListPage} from '@docusaurus/plugin-content-docs';
 
@@ -263,22 +237,6 @@ declare module '@theme/DocTagDocListPage' {
   export default function DocTagDocListPage(props: Props): JSX.Element;
 }
 
-declare module '@theme/DocVersionBanner' {
-  export interface Props {
-    readonly className?: string;
-  }
-
-  export default function DocVersionBanner(props: Props): JSX.Element;
-}
-
-declare module '@theme/DocVersionBadge' {
-  export interface Props {
-    readonly className?: string;
-  }
-
-  export default function DocVersionBadge(props: Props): JSX.Element;
-}
-
 declare module '@theme/DocPage' {
   import type {PropVersionMetadata} from '@docusaurus/plugin-content-docs';
   import type {DocumentRoute} from '@theme/DocItem';
@@ -297,21 +255,6 @@ declare module '@theme/DocPage' {
   export default DocPage;
 }
 
-declare module '@theme/Seo' {
-  import type {ReactNode} from 'react';
-
-  export interface Props {
-    readonly title?: string;
-    readonly description?: string;
-    readonly keywords?: readonly string[] | string;
-    readonly image?: string;
-    readonly children?: ReactNode;
-  }
-
-  const Seo: (props: Props) => JSX.Element;
-  export default Seo;
-}
-
 // TODO until TS supports exports field... hope it's in 4.6
 declare module '@docusaurus/plugin-content-docs/client' {
   export type ActivePlugin = {

package/src/props.ts

@@ -52,7 +52,8 @@ Available document ids are:
       label: sidebarLabel || item.label || title,
       href: permalink,
       className: item.className,
-      customProps: item.customProps,
+      customProps:
+        item.customProps ?? docMetadata.frontMatter.sidebar_custom_props,
       docId: docMetadata.unversionedId,
     };
   };

package/src/types.ts

@@ -58,6 +58,7 @@ export type DocFrontMatter = {
   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;