chore: Machine-readable output (for search mode) #171
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
So far, output for search mode was oriented around human readability. It wasn't easily machine-readable, aka parsing it is difficult. This change detects whether `stdout` is a terminal and switches to a more parse-friendly output if not. While an improvement, the implementation is junk (PoC), and makes me think just providing JSON output is preferable. Then, consumers have maximum flexibility and do not have to write weird custom shell pipelines. A `jq` command would do. For JSON support, we could provide a flag `--json` (ripgrep has that too), and MAYBE perform auto-detection of TTY. For JSON support, we need a new type which encapsulates a new line found in search mode. For example, could be `struct` containing `filename`, `findings`, `ranges`, `line_number` etc., and then is serialized to a JSON line w/ serde.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
So far, output for search mode was oriented around human readability. It wasn't easily
machine-readable, aka parsing it is difficult.
This change detects whether
stdoutis a terminal and switches to a more parse-friendly output ifnot.
While an improvement, the implementation is junk
(PoC), and makes me think just providing JSON
output is preferable. Then, consumers have maximum flexibility and do not have to write weird custom
shell pipelines. A
jqcommand would do.For JSON support, we could provide a flag
--json(ripgrep has that too), and MAYBE performauto-detection of TTY. For JSON support, we need a new type which encapsulates a new line found in
search mode. For example, could be
structcontaining
filename,findings,ranges,line_numberetc., and then is serialized to aJSON line w/ serde.