@docusaurus/utils 0.0.0-4744 → 0.0.0-4750

package/lib/gitUtils.d.ts

@@ -8,12 +8,19 @@ export declare class GitNotFoundError extends Error {
 }
 export declare class FileNotTrackedError extends Error {
 }
-export declare const getFileCommitDate: (file: string, { age, includeAuthor, }: {
-    age?: "oldest" | "newest" | undefined;
-    includeAuthor?: boolean | undefined;
-}) => {
+export declare function getFileCommitDate(file: string, args: {
+    age?: 'oldest' | 'newest';
+    includeAuthor?: false;
+}): {
     date: Date;
     timestamp: number;
-    author?: string | undefined;
+};
+export declare function getFileCommitDate(file: string, args: {
+    age?: 'oldest' | 'newest';
+    includeAuthor: true;
+}): {
+    date: Date;
+    timestamp: number;
+    author: string;
 };
 //# sourceMappingURL=gitUtils.d.ts.map

package/lib/gitUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"gitUtils.d.ts","sourceRoot":"","sources":["../src/gitUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAKH,qBAAa,gBAAiB,SAAQ,KAAK;CAAG;AAE9C,qBAAa,mBAAoB,SAAQ,KAAK;CAAG;AAEjD,eAAO,MAAM,iBAAiB,SACtB,MAAM;;;;UASN,IAAI;eACC,MAAM;;CA4ElB,CAAC"}
+{"version":3,"file":"gitUtils.d.ts","sourceRoot":"","sources":["../src/gitUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAKH,qBAAa,gBAAiB,SAAQ,KAAK;CAAG;AAE9C,qBAAa,mBAAoB,SAAQ,KAAK;CAAG;AAEjD,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE;IAAC,GAAG,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAAC,aAAa,CAAC,EAAE,KAAK,CAAA;CAAC,GACvD;IACD,IAAI,EAAE,IAAI,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AACF,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE;IAAC,GAAG,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAAC,aAAa,EAAE,IAAI,CAAA;CAAC,GACrD;IACD,IAAI,EAAE,IAAI,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/lib/gitUtils.js

@@ -16,15 +16,15 @@ exports.GitNotFoundError = GitNotFoundError;
 class FileNotTrackedError extends Error {
 }
 exports.FileNotTrackedError = FileNotTrackedError;
-const getFileCommitDate = (file, { age = 'oldest', includeAuthor = false, }) => {
+function getFileCommitDate(file, { age = 'oldest', includeAuthor = false, }) {
     if (!shelljs_1.default.which('git')) {
         throw new GitNotFoundError(`Failed to retrieve git history for "${file}" because git is not installed.`);
     }
     if (!shelljs_1.default.test('-f', file)) {
         throw new Error(`Failed to retrieve git history for "${file}" because the file does not exist.`);
     }
-    const fileBasename = path_1.default.basename(file);
-    const fileDirname = path_1.default.dirname(file);
+    // Commit time and author name; not using author time so that amended commits
+    // can have their dates updated
     let formatArg = '--format=%ct';
     if (includeAuthor) {
         formatArg += ',%an';
@@ -35,9 +35,9 @@ const getFileCommitDate = (file, { age = 'oldest', includeAuthor = false, }) =>
         // --diff-filter=A ensures we only get the commit which (A)dded the file
         extraArgs += ' --follow --diff-filter=A';
     }
-    const result = shelljs_1.default.exec(`git log ${extraArgs} ${formatArg} -- "${fileBasename}"`, {
+    const result = shelljs_1.default.exec(`git log ${extraArgs} ${formatArg} -- "${path_1.default.basename(file)}"`, {
         // cwd is important, see: https://github.com/facebook/docusaurus/pull/5048
-        cwd: fileDirname,
+        cwd: path_1.default.dirname(file),
         silent: true,
     });
     if (result.code !== 0) {
@@ -52,10 +52,7 @@ const getFileCommitDate = (file, { age = 'oldest', includeAuthor = false, }) =>
         throw new FileNotTrackedError(`Failed to retrieve the git history for file "${file}" because the file is not tracked by git.`);
     }
     const match = output.match(regex);
-    if (!match ||
-        !match.groups ||
-        !match.groups.timestamp ||
-        (includeAuthor && !match.groups.author)) {
+    if (!match) {
         throw new Error(`Failed to retrieve the git history for file "${file}" with unexpected output: ${output}`);
     }
     const timestamp = Number(match.groups.timestamp);
@@ -64,6 +61,6 @@ const getFileCommitDate = (file, { age = 'oldest', includeAuthor = false, }) =>
         return { date, timestamp, author: match.groups.author };
     }
     return { date, timestamp };
-};
+}
 exports.getFileCommitDate = getFileCommitDate;
 //# sourceMappingURL=gitUtils.js.map

package/lib/gitUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"gitUtils.js","sourceRoot":"","sources":["../src/gitUtils.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,wDAAwB;AACxB,8DAA4B;AAE5B,MAAa,gBAAiB,SAAQ,KAAK;CAAG;AAA9C,4CAA8C;AAE9C,MAAa,mBAAoB,SAAQ,KAAK;CAAG;AAAjD,kDAAiD;AAE1C,MAAM,iBAAiB,GAAG,CAC/B,IAAY,EACZ,EACE,GAAG,GAAG,QAAQ,EACd,aAAa,GAAG,KAAK,GAItB,EAKD,EAAE;IACF,IAAI,CAAC,iBAAK,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE;QACvB,MAAM,IAAI,gBAAgB,CACxB,uCAAuC,IAAI,iCAAiC,CAC7E,CAAC;KACH;IAED,IAAI,CAAC,iBAAK,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE;QAC3B,MAAM,IAAI,KAAK,CACb,uCAAuC,IAAI,oCAAoC,CAChF,CAAC;KACH;IAED,MAAM,YAAY,GAAG,cAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACzC,MAAM,WAAW,GAAG,cAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvC,IAAI,SAAS,GAAG,cAAc,CAAC;IAC/B,IAAI,aAAa,EAAE;QACjB,SAAS,IAAI,MAAM,CAAC;KACrB;IAED,IAAI,SAAS,GAAG,eAAe,CAAC;IAChC,IAAI,GAAG,KAAK,QAAQ,EAAE;QACpB,+CAA+C;QAC/C,wEAAwE;QACxE,SAAS,IAAI,2BAA2B,CAAC;KAC1C;IAED,MAAM,MAAM,GAAG,iBAAK,CAAC,IAAI,CACvB,WAAW,SAAS,IAAI,SAAS,QAAQ,YAAY,GAAG,EACxD;QACE,0EAA0E;QAC1E,GAAG,EAAE,WAAW;QAChB,MAAM,EAAE,IAAI;KACb,CACF,CAAC;IACF,IAAI,MAAM,CAAC,IAAI,KAAK,CAAC,EAAE;QACrB,MAAM,IAAI,KAAK,CACb,gDAAgD,IAAI,oBAAoB,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,MAAM,EAAE,CACxG,CAAC;KACH;IACD,IAAI,KAAK,GAAG,qBAAqB,CAAC;IAClC,IAAI,aAAa,EAAE;QACjB,KAAK,GAAG,mCAAmC,CAAC;KAC7C;IAED,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;IAEpC,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,IAAI,mBAAmB,CAC3B,gDAAgD,IAAI,2CAA2C,CAChG,CAAC;KACH;IAED,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAElC,IACE,CAAC,KAAK;QACN,CAAC,KAAK,CAAC,MAAM;QACb,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS;QACvB,CAAC,aAAa,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,EACvC;QACA,MAAM,IAAI,KAAK,CACb,gDAAgD,IAAI,6BAA6B,MAAM,EAAE,CAC1F,CAAC;KACH;IAED,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACjD,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC;IAExC,IAAI,aAAa,EAAE;QACjB,OAAO,EAAC,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAC,CAAC;KACvD;IACD,OAAO,EAAC,IAAI,EAAE,SAAS,EAAC,CAAC;AAC3B,CAAC,CAAC;AAvFW,QAAA,iBAAiB,qBAuF5B"}
+{"version":3,"file":"gitUtils.js","sourceRoot":"","sources":["../src/gitUtils.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,wDAAwB;AACxB,8DAA4B;AAE5B,MAAa,gBAAiB,SAAQ,KAAK;CAAG;AAA9C,4CAA8C;AAE9C,MAAa,mBAAoB,SAAQ,KAAK;CAAG;AAAjD,kDAAiD;AAiBjD,SAAgB,iBAAiB,CAC/B,IAAY,EACZ,EACE,GAAG,GAAG,QAAQ,EACd,aAAa,GAAG,KAAK,GAItB;IAMD,IAAI,CAAC,iBAAK,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE;QACvB,MAAM,IAAI,gBAAgB,CACxB,uCAAuC,IAAI,iCAAiC,CAC7E,CAAC;KACH;IAED,IAAI,CAAC,iBAAK,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE;QAC3B,MAAM,IAAI,KAAK,CACb,uCAAuC,IAAI,oCAAoC,CAChF,CAAC;KACH;IAED,6EAA6E;IAC7E,+BAA+B;IAC/B,IAAI,SAAS,GAAG,cAAc,CAAC;IAC/B,IAAI,aAAa,EAAE;QACjB,SAAS,IAAI,MAAM,CAAC;KACrB;IAED,IAAI,SAAS,GAAG,eAAe,CAAC;IAChC,IAAI,GAAG,KAAK,QAAQ,EAAE;QACpB,+CAA+C;QAC/C,wEAAwE;QACxE,SAAS,IAAI,2BAA2B,CAAC;KAC1C;IAED,MAAM,MAAM,GAAG,iBAAK,CAAC,IAAI,CACvB,WAAW,SAAS,IAAI,SAAS,QAAQ,cAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAC/D;QACE,0EAA0E;QAC1E,GAAG,EAAE,cAAI,CAAC,OAAO,CAAC,IAAI,CAAC;QACvB,MAAM,EAAE,IAAI;KACb,CACF,CAAC;IACF,IAAI,MAAM,CAAC,IAAI,KAAK,CAAC,EAAE;QACrB,MAAM,IAAI,KAAK,CACb,gDAAgD,IAAI,oBAAoB,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,MAAM,EAAE,CACxG,CAAC;KACH;IACD,IAAI,KAAK,GAAG,qBAAqB,CAAC;IAClC,IAAI,aAAa,EAAE;QACjB,KAAK,GAAG,mCAAmC,CAAC;KAC7C;IAED,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;IAEpC,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,IAAI,mBAAmB,CAC3B,gDAAgD,IAAI,2CAA2C,CAChG,CAAC;KACH;IAED,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAElC,IAAI,CAAC,KAAK,EAAE;QACV,MAAM,IAAI,KAAK,CACb,gDAAgD,IAAI,6BAA6B,MAAM,EAAE,CAC1F,CAAC;KACH;IAED,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,CAAC,MAAO,CAAC,SAAS,CAAC,CAAC;IAClD,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC;IAExC,IAAI,aAAa,EAAE;QACjB,OAAO,EAAC,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,CAAC,MAAO,CAAC,MAAO,EAAC,CAAC;KACzD;IACD,OAAO,EAAC,IAAI,EAAE,SAAS,EAAC,CAAC;AAC3B,CAAC;AAjFD,8CAiFC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/utils",
-  "version": "0.0.0-4744",
+  "version": "0.0.0-4750",
   "description": "Node utility functions for Docusaurus packages.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -18,7 +18,7 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/logger": "0.0.0-4744",
+    "@docusaurus/logger": "0.0.0-4750",
     "@svgr/webpack": "^6.2.1",
     "file-loader": "^6.2.0",
     "fs-extra": "^10.0.1",
@@ -38,12 +38,12 @@
     "node": ">=14"
   },
   "devDependencies": {
-    "@docusaurus/types": "0.0.0-4744",
+    "@docusaurus/types": "0.0.0-4750",
     "@types/dedent": "^0.7.0",
     "@types/github-slugger": "^1.3.0",
     "@types/micromatch": "^4.0.2",
     "@types/react-dom": "^17.0.14",
     "dedent": "^0.7.0"
   },
-  "gitHead": "ad55cb76da61f219f0cbce23fd0f7191e7ac3703"
+  "gitHead": "6d0cf0bf7ead33dbb6553e16ce44da6a9999a8ed"
 }

package/src/gitUtils.ts

@@ -12,7 +12,22 @@ export class GitNotFoundError extends Error {}
 
 export class FileNotTrackedError extends Error {}
 
-export const getFileCommitDate = (
+export function getFileCommitDate(
+  file: string,
+  args: {age?: 'oldest' | 'newest'; includeAuthor?: false},
+): {
+  date: Date;
+  timestamp: number;
+};
+export function getFileCommitDate(
+  file: string,
+  args: {age?: 'oldest' | 'newest'; includeAuthor: true},
+): {
+  date: Date;
+  timestamp: number;
+  author: string;
+};
+export function getFileCommitDate(
   file: string,
   {
     age = 'oldest',
@@ -25,7 +40,7 @@ export const getFileCommitDate = (
   date: Date;
   timestamp: number;
   author?: string;
-} => {
+} {
   if (!shell.which('git')) {
     throw new GitNotFoundError(
       `Failed to retrieve git history for "${file}" because git is not installed.`,
@@ -38,9 +53,8 @@ export const getFileCommitDate = (
     );
   }
 
-  const fileBasename = path.basename(file);
-  const fileDirname = path.dirname(file);
-
+  // Commit time and author name; not using author time so that amended commits
+  // can have their dates updated
   let formatArg = '--format=%ct';
   if (includeAuthor) {
     formatArg += ',%an';
@@ -54,10 +68,10 @@ export const getFileCommitDate = (
   }
 
   const result = shell.exec(
-    `git log ${extraArgs} ${formatArg} -- "${fileBasename}"`,
+    `git log ${extraArgs} ${formatArg} -- "${path.basename(file)}"`,
     {
       // cwd is important, see: https://github.com/facebook/docusaurus/pull/5048
-      cwd: fileDirname,
+      cwd: path.dirname(file),
       silent: true,
     },
   );
@@ -81,22 +95,17 @@ export const getFileCommitDate = (
 
   const match = output.match(regex);
 
-  if (
-    !match ||
-    !match.groups ||
-    !match.groups.timestamp ||
-    (includeAuthor && !match.groups.author)
-  ) {
+  if (!match) {
     throw new Error(
       `Failed to retrieve the git history for file "${file}" with unexpected output: ${output}`,
     );
   }
 
-  const timestamp = Number(match.groups.timestamp);
+  const timestamp = Number(match.groups!.timestamp);
   const date = new Date(timestamp * 1000);
 
   if (includeAuthor) {
-    return {date, timestamp, author: match.groups.author};
+    return {date, timestamp, author: match.groups!.author!};
   }
   return {date, timestamp};
-};
+}