Merge pull request #948 from steveukx/fix/git-log-pathspec

git.log should include a pathspec splitter automatically when using --follow
steveukx · Sep 23, 2023 · d84dd63 · d84dd63
2 parents 9000caf + ebbfe8e
commit d84dd63
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 5 deletions.
diff --git a/.changeset/sweet-steaks-draw.md b/.changeset/sweet-steaks-draw.md
@@ -0,0 +1,5 @@
+---
+'simple-git': minor
+---
+
+Use `pathspec` in `git.log` to allow use of previously deleted files in `file` argument
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -14,7 +14,7 @@ jobs:
       runs-on: ubuntu-latest
       strategy:
          matrix:
-            node-version: [14, 16, 18, 19]
+            node-version: [14, 16, 18, 20]
       steps:
          - uses: actions/checkout@v4
          - name: Use Node.js ${{ matrix.node-version }}

diff --git a/simple-git/src/lib/tasks/log.ts b/simple-git/src/lib/tasks/log.ts
@@ -1,6 +1,7 @@
 import type { Options, StringTask } from '../types';
 import type { LogResult, SimpleGit } from '../../../typings';
 import { logFormatFromCommand } from '../args/log-format';
+import { pathspec } from '../args/pathspec';
 import {
    COMMIT_BOUNDARY,
    createListLogSummaryParser,
@@ -126,7 +127,7 @@ export function parseLogOptions<T extends Options>(
    }
 
    if (filterString(opt.file)) {
-      suffix.push('--follow', opt.file);
+      command.push('--follow', pathspec(opt.file));
    }
 
    appendTaskOptions(userOptions(opt as Options), command);

diff --git a/simple-git/test/unit/log.spec.ts b/simple-git/test/unit/log.spec.ts
@@ -1,5 +1,5 @@
 import { promiseError } from '@kwsites/promise-result';
-import { LogResult, SimpleGit } from 'typings';
+import type { LogResult, SimpleGit } from 'typings';
 import {
    assertExecutedCommands,
    assertExecutedCommandsContains,
@@ -9,7 +9,7 @@ import {
    like,
    newSimpleGit,
 } from './__fixtures__';
-import { TaskConfigurationError } from '../..';
+import { TaskConfigurationError, pathspec } from '../..';
 import {
    COMMIT_BOUNDARY,
    createListLogSummaryParser,
@@ -33,8 +33,46 @@ describe('log', () => {
       assertExecutedCommands(
          'log',
          `--pretty=format:${START_BOUNDARY}%H${COMMIT_BOUNDARY}`,
+         '--follow',
          '--fixed-strings',
+         '--',
+         'index.js'
+      );
+   });
+
+   it('follow option works with explicit pathspec', async () => {
+      git.log({
+         'file': 'index.js',
+         'format': { hash: '%H' },
+         '--fixed-strings': null,
+         'path': pathspec('file2'),
+      });
+      await closeWithSuccess();
+
+      assertExecutedCommands(
+         'log',
+         `--pretty=format:${START_BOUNDARY}%H${COMMIT_BOUNDARY}`,
+         '--follow',
+         '--fixed-strings',
+         '--',
+         'index.js',
+         'file2'
+      );
+   });
+
+   it('follow option works with pathspec workaround', async () => {
+      git.log({
+         'format': { hash: '%H' },
+         'file': 'index.js',
+         '--': null,
+      });
+      await closeWithSuccess();
+
+      assertExecutedCommands(
+         'log',
+         `--pretty=format:${START_BOUNDARY}%H${COMMIT_BOUNDARY}`,
          '--follow',
+         '--',
          'index.js'
       );
    });
@@ -542,7 +580,7 @@ ${START_BOUNDARY}207601debebc170830f2921acf2b6b27034c3b1f::2016-01-03 15:50:58 +
          git.log({ file: '/foo/bar.txt', n: 10 });
          await closeWithSuccess();
 
-         assertCommandAppended('--max-count=10', '--follow', '/foo/bar.txt');
+         assertCommandAppended('--max-count=10', '--follow', '--', '/foo/bar.txt');
       });
 
       function assertCommandAppended(...things: string[]) {