git.grep and pathspec not working as expected

[didoo]

issue

If a pathspec option is provided to the git.grep command, it's not appended as last option per official documentation but it appears before the -e option, which causes git to fail:

I tried different alternatives to provide the arguments, to bypass the problem, but none of them worked. Looking at the source code, my understanding is that the -e option is always appendend (but this should not be the case if a pathspec argument is provided).

Any idea if there is a workaround? Should this be considered a bug? I may try to open a PR, if there's no alternatives, but since I'm new to this codebase I would prefer to be sure that my understanding of the problem is correct.

[steveukx]

Hello, please can you include the code you are using to generate the arguments - is this through the grepQueryBuilder ?

[didoo]

Hello, please can you include the code you are using to generate the arguments - is this through the grepQueryBuilder ?

@steveukx I have tried both these variants, but both lead to the same problem of arguments order:

const grepResultsPds = await git.grep('<Pds::', ['--ignore-case', '--count', '--', '*.hbs']);

const grepResultsPds = await git.grep(grepQueryBuilder('<Pds::'), ['--ignore-case', '--count', '--', '--*.hbs']);

[steveukx]

Apologies for the delay, but thank you for the detail in the issue.

From the next release, which will be this week, you will be able to use a pathspec utility in the trailing TaskOptions array/object that handles the -- separation for you.

import {pathspec, simpleGit} from 'simple-git'
const grepResultsPds = await git.grep('<Pds::', ['--ignore-case',  pathspec('*.hbs')]);

[didoo]

@steveukx thank you for the fix (I see the same issue with the command submoduleUpdate, and probably subModule)
let me know when it's released so I can test it (for now I had to fallback to use execSync)

[steveukx]

Hi @didoo the changes are now live in 3.19.0 and should "just work" in any task that allowed a trailing TaskOptions array or object (and in some that don't - for example git.add([ pathspec('abc' ]). If you do have problems though, please open a new issue and I'll have a look into it.

[didoo]

@steveukx tested now, and works like a charm! Thank you for the fix 🙏