Add support for jq compatible hunk headers.
#100
Conversation
* `jq` is a pretty popular cli tool for processing json docs.
* This commit adds support for generating the hunk headers that could be
copied into a jq command (minus the first '.').
* For that, we add:
* a render option - `JQPATH` - so that it can be explicitly
controlled.
* a `JqPath()` method on the `Path` - to render the path.
* a call to `JqPath()` in `diff_write.go:Render()` - based on the
passed render options.
* also, corresponding tests in `diff_write_test.go`
Signed-off-by: Kunal Gangakhedkar <[email protected]>
Passing this flag to the 'jd' binary should render the hunk header as jq compatible json path. Signed-off-by: Kunal Gangakhedkar <[email protected]>
kunal-g
changed the title
jq compatible hunk headers.
|
@kunal-g can you tell me more about what you're trying to accomplish with this change. It's nice that the headers could be |
|
the typical use-case here is:
With Comparison with unified diffIt's difficult to pre-determine how much of context we need to capture in the diff especially when dealing with arrays. Unified diff is line-oriented and hence, specifying no. of lines with the JSON data can be in minified form - not suitable for line-oriented context. I hope this gives you enough context about the motivation for the change. I am more than happy to collaborate if you have any alternative suggestions that can help with the use-case 😃 |
|
@josephburnett bumping up. |
2 participants
jqis a quite popular cli tool for processing json docs.copied into a jq command (minus the first
.).JQPATH- so that it can be explicitly controlled.JqPath()method on thePath- to render the path.JqPath()indiff_write.go:Render()- based on thepassed render options.
diff_write_test.goThis change allows us to simply copy the dotted JSON path from the hunk header and inspect that element with
jq.jq '.<copied-json-path-from-hunk-header>' <original_file>.jsonjq '.<copied-json-path-from-hunk-header>' <updated_file>.json.needs to be explicitly added in the abovejqcommands.Signed-off-by: Kunal Gangakhedkar [email protected]