chore(core): replace shell calls by simple git

packages/docusaurus-utils/package.json

@@ -34,6 +34,7 @@
  "prompts": "^2.4.2",
  "resolve-pathname": "^3.0.0",
  "shelljs": "^0.8.5",
+ "simple-git": "^3.25.0",
  "tslib": "^2.6.0",
  "url-loader": "^4.1.1",
  "utility-types": "^3.10.0",

packages/docusaurus-utils/src/gitUtils.ts

@@ -9,6 +9,7 @@ import path from 'path';
 import fs from 'fs-extra';
 import _ from 'lodash';
 import shell from 'shelljs'; // TODO replace with async-first version
+import simpleGit from 'simple-git';
 
 const realHasGitFn = () => !!shell.which('git');
 
@@ -101,6 +102,7 @@ export async function getFileCommitDate(
  );
  }
 
+ const git = simpleGit(path.dirname(file));
  if (!(await fs.pathExists(file))) {
  throw new Error(
  `Failed to retrieve git history for "${file}" because the file does not exist.`,
@@ -110,52 +112,23 @@ export async function getFileCommitDate(
  // We add a "RESULT:" prefix to make parsing easier
  // See why: https://github.com/facebook/docusaurus/pull/10022
  const resultFormat = includeAuthor ? 'RESULT:%ct,%an' : 'RESULT:%ct';
+ const args = ['log', `--format=${resultFormat}`, '--max-count=1'];
 
- const args = [
- `--format=${resultFormat}`,
- '--max-count=1',
- age === 'oldest' ? '--follow --diff-filter=A' : undefined,
- ]
- .filter(Boolean)
- .join(' ');
-
- const command = `git -c log.showSignature=false log ${args} -- "${path.basename(
- file,
- )}"`;
-
- const result = await new Promise<{
- code: number;
- stdout: string;
- stderr: string;
- }>((resolve) => {
- shell.exec(
- command,
- {
- // Setting cwd is important, see: https://github.com/facebook/docusaurus/pull/5048
- cwd: path.dirname(file),
- silent: true,
- },
- (code, stdout, stderr) => {
- resolve({code, stdout, stderr});
- },
- );
- });
-
- if (result.code !== 0) {
- throw new Error(
- `Failed to retrieve the git history for file "${file}" with exit code ${result.code}: ${result.stderr}`,
- );
+ if (age === 'oldest') {
+ args.push('--follow', '--diff-filter=A');
  }
 
+ args.push('--', path.basename(file));
+
  // We only parse the output line starting with our "RESULT:" prefix
  // See why https://github.com/facebook/docusaurus/pull/10022
  const regex = includeAuthor
  ? /(?:^|\n)RESULT:(?<timestamp>\d+),(?<author>.+)(?:$|\n)/
  : /(?:^|\n)RESULT:(?<timestamp>\d+)(?:$|\n)/;
 
- const output = result.stdout.trim();
+ const output = await git.raw(args);
 
- if (!output) {
+ if (!output.trim()) {
  throw new FileNotTrackedError(
  `Failed to retrieve the git history for file "${file}" because the file is not tracked by git.`,
  );

yarn.lock

@@ -2022,6 +2022,18 @@
  "@jridgewell/resolve-uri" "^3.1.0"
  "@jridgewell/sourcemap-codec" "^1.4.14"
 
+"@kwsites/file-exists@^1.1.1":
+ version "1.1.1"
+ resolved "https://registry.yarnpkg.com/@kwsites/file-exists/-/file-exists-1.1.1.tgz#ad1efcac13e1987d8dbaf235ef3be5b0d96faa99"
+ integrity sha512-m9/5YGR18lIwxSFDwfE3oA7bWuq9kdau6ugN4H2rJeyhFQZcG9AgSHkQtSD15a8WvTgfz9aikZMrKPHvbpqFiw==
+ dependencies:
+ debug "^4.1.1"
+
+"@kwsites/promise-deferred@^1.1.1":
+ version "1.1.1"
+ resolved "https://registry.yarnpkg.com/@kwsites/promise-deferred/-/promise-deferred-1.1.1.tgz#8ace5259254426ccef57f3175bc64ed7095ed919"
+ integrity sha512-GaHYm+c0O9MjZRu0ongGBRbinu8gVAMd2UZjji6jVmqKtZluZnptXGWhz1E8j8D2HJ3f/yMxKAUC0b+57wncIw==
+
 "@leichtgewicht/ip-codec@^2.0.1":
  version "2.0.4"
  resolved "https://registry.yarnpkg.com/@leichtgewicht/ip-codec/-/ip-codec-2.0.4.tgz#b2ac626d6cb9c8718ab459166d4bb405b8ffa78b"
@@ -6427,10 +6439,10 @@ debug@2.6.9, debug@^2.6.0:
  dependencies:
  ms "2.0.0"
 
-debug@4, debug@^4.0.0, debug@^4.1.0, debug@^4.1.1, debug@^4.3.1, debug@^4.3.2, debug@^4.3.3, debug@^4.3.4:
- version "4.3.4"
- resolved "https://registry.yarnpkg.com/debug/-/debug-4.3.4.tgz#1319f6579357f2338d3337d2cdd4914bb5dcc865"
- integrity sha512-PRWFHuSU3eDtQJPvnNY7Jcket1j0t5OuOsFzPPzsekD52Zl8qUfFIPEiswXqIvHWGVHOgX+7G/vCNNhehwxfkQ==
+debug@4, debug@^4.0.0, debug@^4.1.0, debug@^4.1.1, debug@^4.3.1, debug@^4.3.2, debug@^4.3.3, debug@^4.3.4, debug@^4.3.5:
+ version "4.3.6"
+ resolved "https://registry.yarnpkg.com/debug/-/debug-4.3.6.tgz#2ab2c38fbaffebf8aa95fdfe6d88438c7a13c52b"
+ integrity sha512-O/09Bd4Z1fBrU4VzkhFqVgpPzaGbw6Sm9FEkBT1A/YBXQFGuuSxa1dN2nxgxS34JmKXqYx8CZAwEVoJFImUXIg==
  dependencies:
  ms "2.1.2"
 
@@ -14926,6 +14938,15 @@ simple-get@^4.0.0, simple-get@^4.0.1:
  once "^1.3.1"
  simple-concat "^1.0.0"
 
+simple-git@^3.25.0:
+ version "3.25.0"
+ resolved "https://registry.yarnpkg.com/simple-git/-/simple-git-3.25.0.tgz#3666e76d6831f0583dc380645945b97e0ac4aab6"
+ integrity sha512-KIY5sBnzc4yEcJXW7Tdv4viEz8KyG+nU0hay+DWZasvdFOYKeUZ6Xc25LUHHjw0tinPT7O1eY6pzX7pRT1K8rw==
+ dependencies:
+ "@kwsites/file-exists" "^1.1.1"
+ "@kwsites/promise-deferred" "^1.1.1"
+ debug "^4.3.5"
+
 simple-swizzle@^0.2.2:
  version "0.2.2"
  resolved "https://registry.yarnpkg.com/simple-swizzle/-/simple-swizzle-0.2.2.tgz#a4da6b635ffcccca33f70d17cb92592de95e557a"
@@ -15245,16 +15266,7 @@ string-length@^4.0.1:
  char-regex "^1.0.2"
  strip-ansi "^6.0.0"
 
-"string-width-cjs@npm:string-width@^4.2.0":
- version "4.2.3"
- resolved "https://registry.yarnpkg.com/string-width/-/string-width-4.2.3.tgz#269c7117d27b05ad2e536830a8ec895ef9c6d010"
- integrity sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==
- dependencies:
- emoji-regex "^8.0.0"
- is-fullwidth-code-point "^3.0.0"
- strip-ansi "^6.0.1"
-
-"string-width@^1.0.2 || 2 || 3 || 4", string-width@^4.1.0, string-width@^4.2.0, string-width@^4.2.3:
+"string-width-cjs@npm:string-width@^4.2.0", "string-width@^1.0.2 || 2 || 3 || 4", string-width@^4.1.0, string-width@^4.2.0, string-width@^4.2.3:
  version "4.2.3"
  resolved "https://registry.yarnpkg.com/string-width/-/string-width-4.2.3.tgz#269c7117d27b05ad2e536830a8ec895ef9c6d010"
  integrity sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==
@@ -15353,14 +15365,7 @@ stringify-object@^3.3.0:
  is-obj "^1.0.1"
  is-regexp "^1.0.0"
 
-"strip-ansi-cjs@npm:strip-ansi@^6.0.1":
- version "6.0.1"
- resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-6.0.1.tgz#9e26c63d30f53443e9489495b2105d37b67a85d9"
- integrity sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==
- dependencies:
- ansi-regex "^5.0.1"
-
-strip-ansi@^6.0.0, strip-ansi@^6.0.1:
+"strip-ansi-cjs@npm:strip-ansi@^6.0.1", strip-ansi@^6.0.0, strip-ansi@^6.0.1:
  version "6.0.1"
  resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-6.0.1.tgz#9e26c63d30f53443e9489495b2105d37b67a85d9"
  integrity sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==
@@ -17025,7 +17030,7 @@ workbox-window@7.0.0, workbox-window@^7.0.0:
  "@types/trusted-types" "^2.0.2"
  workbox-core "7.0.0"
 
-"wrap-ansi-cjs@npm:wrap-ansi@^7.0.0":
+"wrap-ansi-cjs@npm:wrap-ansi@^7.0.0", wrap-ansi@^7.0.0:
  version "7.0.0"
  resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-7.0.0.tgz#67e145cff510a6a6984bdf1152911d69d2eb9e43"
  integrity sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==
@@ -17043,15 +17048,6 @@ wrap-ansi@^6.2.0:
  string-width "^4.1.0"
  strip-ansi "^6.0.0"
 
-wrap-ansi@^7.0.0:
- version "7.0.0"
- resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-7.0.0.tgz#67e145cff510a6a6984bdf1152911d69d2eb9e43"
- integrity sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==
- dependencies:
- ansi-styles "^4.0.0"
- string-width "^4.1.0"
- strip-ansi "^6.0.0"
-
 wrap-ansi@^8.0.1, wrap-ansi@^8.1.0:
  version "8.1.0"
  resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-8.1.0.tgz#56dc22368ee570face1b49819975d9b9a5ead214"