git grep

[mac2000]

Will be so nice to have git grep command, e.g.:

$ git grep "Something"
src/demo.js:                        console.log('Something happened')
test/demo.spec.js:  "Seomething": "Should not be printed",

const results = await git.grep('Something')
console.log(results[0][0]) // src/demo.js
console.log(results[0][1]) // console.log('Something happened')

it might be as easy as calling exec sync and parsing stdout with something like:

stdout.split("\n").map(line => line.trim()).filter(line => !!line).map(line => line.split(/:\s+/g))

something like:

src/lib/tasks/grep.ts

import { StringTask } from '../types';

export function grepTask(regexp: string): StringTask<string[][]> {
   return {
      commands: ['grep', regexp],
      format: 'utf-8',
      parser (stdOut) {
         return stdOut.split("\n").map(line => line.trim()).filter(line => !!line).map(line => line.split(/:\s+/g));
      }
   }
}

[steveukx]

git grep is a great suggestion, thank you for opening the issue.

I will add a task, similar to the implementation you've suggested but making use of the utilities in the package for parsing responses line by line, and allowing supported options to be passed through to git.

[mac2000]

BTW: just in case, I gave you wrong chain, it wont handle strings like:

"foo": "acme: 42"

more correct one will be:

stdou
    .toString()
    .split("\n")
    .map(line => line.trim())
    .filter(line => !!line)
    .map(line => [line.split(/:\s+/, 1).shift(), line.substring(line.split(/:\s+/, 1).shift().length).replace(/^:\s+/, '')])
    .map(([path, line]) => ({path, line}))

yep, it isn't optiomal, just want to highlight mistake

[steveukx]

Hi, you can now make use of git.grep(...) in simple-git version 2.47.0 on npm now.

Examples: https://github.com/steveukx/git-js/blob/main/examples/git-grep.md

Please do let me know if you have any difficulties using it.