git-grep-json

It's a tool for git-grep.
See https://git-grep-json.netlify.app/ also.

!npm
!NPM
!npms.io (quality)
!Libraries.io dependency status for latest release
!Maintenance

installation

`` shell
npm install git-grep-json
`

usage

- grep with -n and -C
` shell
git grep -n -C 2 -e "some" | npx grep2json
`

- grep with -n and -A
` shell
git grep -n -A 1 -e "some" | npx grep2json
`

- grep with -n and -B
` shell
git grep -n -B 1 -e "some" | npx grep2json
`

- result
` shell
[
{
"fileName": "test.js",
"matchedLineNumber": 1,
"codeLines": [
"function someFunc(){",
" return 1;"
],
"lineRange": {
"start": 1,
"end": 2
}
},
{
"fileName": "test.js",
"matchedLineNumber": 6,
"codeLines": [
"function otherFunc(){",
" return \"awesome\";",
"}"
],
"lineRange": {
"start": 5,
"end": 7
}
}
]
`

configurations

grep2json.config.js in process currend directory can change the outout.

You can get grep2json.config.js with the below line
` shell
npx gren2json --init-config
`

configuration example
` javascript
module.exports = {
prepareStore: async () => await Promise.resolve({}),
setupResult: async (block, structuredLine, store) => {
return await Promise.resolve({
fileName: structuredLine.fileName,
matchedLineNumber: structuredLine.lineNumber,
line: structuredLine.codeLine
});
}
};
`

$3

prepareStore() in grep2json.config.js will be executed once before setupResult().

prepareStore() should return a Promise that resolves as any object.

$3

setupResult() in grep2json.config.js will be executed with each matched line.

setupResult() should return a Promise that resolves as any object.

setupResult()` receives block, line, and store as the parameters.