grep other branches without checkout

[Bill2015]

I am trying to use the git grep command to search for text in other branches without checking out to those branches.
Although the git grep command allows me to do this by specifying the branch name (e.g. git grep <Regex> <branchName>), the current grep() function does not seem to support this.

The only way to search for text in other branches is to disable ts-check and then use the following code:

// @ts-nocheck
const result = await simpleGit().grep(['hello', 'origin/master'], ['-C', '1']);

Is there any other way to do this, or is it necessary to implement this feature?

[steveukx]

Hello, have you followed the examples in https://github.com/steveukx/git-js/blob/main/examples/git-grep.md ? The grepQueryBuilder provides more of a builder patter to create the grep query that may be of use to you.

I haven't explicitly added options for querying on branches other than the one you have checked out. What would you expect that git command to look like if you were running it in terminal directly?

[Bill2015]

Thanks for your reply.
I apologize for my poor English, as it is not my first language.

I've used the examples, but the QueryBuilder only support the keyword.

But if i want search keyword components or 'utils'
I can run this command in terminal

git grep -e components -e utils origin/master

Also if I add pathspec filter it will be like this

git grep -e components -e utils origin/master -- '*.tsx'

Also I've look the source code
In this line

git-js/simple-git/src/lib/tasks/grep.ts

Line 92 in fc10fbe

const commands = ['grep', '--null', '-n', '--full-name', ...options, ...searchTerm];

The options is front of searchTerm so it is no way to add branch or pathspec
Also if wrote like this

const result = await simpleGit().grep('ts-node origin/frontend');

it will run this like below

git grep -e 'components origin/master'

The git will combine the components and origin/master as a search term
And this source code when I input searchTerm as a string do

git-js/simple-git/src/lib/tasks/grep.ts

Line 88 in fc10fbe

if (typeof searchTerm === 'string') {

If this a enhanced feature or bug, could I contribute this?