Skip to content

Commit

Permalink
fix: use new --diff and --diff-filter options when checking task …
Browse files Browse the repository at this point in the history
…modifications
  • Loading branch information
andrewmiroshnichenko authored Jun 16, 2022
1 parent 32806da commit 1a5a66a
Show file tree
Hide file tree
Showing 5 changed files with 84 additions and 21 deletions.
18 changes: 18 additions & 0 deletions lib/getDiffCommand.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
export function getDiffCommand(diff, diffFilter) {
/**
* Docs for --diff-filter option:
* @see https://git-scm.com/docs/git-diff#Documentation/git-diff.txt---diff-filterACDMRTUXB82308203
*/
const diffFilterArg = diffFilter !== undefined ? diffFilter.trim() : 'ACMR'

/** Use `--diff branch1...branch2` or `--diff="branch1 branch2", or fall back to default staged files */
const diffArgs = diff !== undefined ? diff.trim().split(' ') : ['--staged']

/**
* Docs for -z option:
* @see https://git-scm.com/docs/git-diff#Documentation/git-diff.txt--z
*/
const diffCommand = ['diff', '--name-only', '-z', `--diff-filter=${diffFilterArg}`, ...diffArgs]

return diffCommand
}
19 changes: 2 additions & 17 deletions lib/getStagedFiles.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,12 @@ import path from 'node:path'
import normalize from 'normalize-path'

import { execGit } from './execGit.js'
import { getDiffCommand } from './getDiffCommand.js'
import { parseGitZOutput } from './parseGitZOutput.js'

export const getStagedFiles = async ({ cwd = process.cwd(), diff, diffFilter } = {}) => {
try {
/**
* Docs for --diff-filter option:
* @see https://git-scm.com/docs/git-diff#Documentation/git-diff.txt---diff-filterACDMRTUXB82308203
*/
const diffFilterArg = diffFilter !== undefined ? diffFilter.trim() : 'ACMR'

/** Use `--diff branch1...branch2` or `--diff="branch1 branch2", or fall back to default staged files */
const diffArgs = diff !== undefined ? diff.trim().split(' ') : ['--staged']

/**
* Docs for -z option:
* @see https://git-scm.com/docs/git-diff#Documentation/git-diff.txt--z
*/
const lines = await execGit(
['diff', '--name-only', '-z', `--diff-filter=${diffFilterArg}`, ...diffArgs],
{ cwd }
)
const lines = await execGit(getDiffCommand(diff, diffFilter), { cwd })
if (!lines) return []

return parseGitZOutput(lines).map((file) => normalize(path.resolve(cwd, file)))
Expand Down
8 changes: 5 additions & 3 deletions lib/gitWorkflow.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import debug from 'debug'

import { execGit } from './execGit.js'
import { readFile, unlink, writeFile } from './file.js'
import { getDiffCommand } from './getDiffCommand.js'
import {
GitError,
RestoreOriginalStateError,
Expand Down Expand Up @@ -65,12 +66,13 @@ const handleError = (error, ctx, symbol) => {
}

export class GitWorkflow {
constructor({ allowEmpty, gitConfigDir, gitDir, matchedFileChunks }) {
constructor({ allowEmpty, gitConfigDir, gitDir, matchedFileChunks, diff, diffFilter }) {
this.execGit = (args, options = {}) => execGit(args, { ...options, cwd: gitDir })
this.deletedFiles = []
this.gitConfigDir = gitConfigDir
this.gitDir = gitDir
this.unstagedDiff = null
this.diff = diff
this.diffFilter = diffFilter
this.allowEmpty = allowEmpty
this.matchedFileChunks = matchedFileChunks

Expand Down Expand Up @@ -262,7 +264,7 @@ export class GitWorkflow {

debugLog('Done adding task modifications to index!')

const stagedFilesAfterAdd = await this.execGit(['diff', '--name-only', '--cached'])
const stagedFilesAfterAdd = await this.execGit(getDiffCommand(this.diff, this.diffFilter))
if (!stagedFilesAfterAdd && !this.allowEmpty) {
// Tasks reverted all staged changes and the commit would be empty
// Throw error to stop commit unless `--allow-empty` was used
Expand Down
9 changes: 8 additions & 1 deletion lib/runAll.js
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,14 @@ export const runAll = async (
relative: false,
})

const git = new GitWorkflow({ allowEmpty, gitConfigDir, gitDir, matchedFileChunks })
const git = new GitWorkflow({
allowEmpty,
gitConfigDir,
gitDir,
matchedFileChunks,
diff,
diffFilter,
})

const runner = new Listr(
[
Expand Down
51 changes: 51 additions & 0 deletions test/unit/getDiffCommand.spec.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
import { getDiffCommand } from '../../lib/getDiffCommand.js'

describe('chunkFiles', () => {
const customDiffString = 'origin/main..custom-branch'
const customDiffSpaceSeparatedString = 'origin/main custom-branch'
const customDiffFilter = 'a'

it('should default to sane value', () => {
const diff = getDiffCommand()
expect(diff).toEqual(['diff', '--name-only', '-z', `--diff-filter=ACMR`, '--staged'])
})

it('should work only with diff set as string', () => {
const diff = getDiffCommand(customDiffString)
expect(diff).toEqual([
'diff',
'--name-only',
'-z',
`--diff-filter=ACMR`,
'origin/main..custom-branch',
])
})

it('should work only with diff set as space separated string', () => {
const diff = getDiffCommand(customDiffSpaceSeparatedString)
expect(diff).toEqual([
'diff',
'--name-only',
'-z',
`--diff-filter=ACMR`,
'origin/main',
'custom-branch',
])
})

it('should work only with diffFilter set', () => {
const diff = getDiffCommand(undefined, customDiffFilter)
expect(diff).toEqual(['diff', '--name-only', '-z', `--diff-filter=a`, '--staged'])
})

it('should work with both diff and diffFilter set', () => {
const diff = getDiffCommand(customDiffString, customDiffFilter)
expect(diff).toEqual([
'diff',
'--name-only',
'-z',
`--diff-filter=a`,
'origin/main..custom-branch',
])
})
})

0 comments on commit 1a5a66a

Please sign in to comment.