feat(cmd): add the strip_newline flag
#1423
Merged
Conversation
This file contains hidden or 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
This commit adds the `strip_newline` flag to the `Git.execute` method. When this flag is set to `True`, it will trim the trailing `\n`. The default value is `True` for backward compatibility. Setting it to `False` is helpful for, e.g., the `git show` output, especially with the binary file, as the missing `\n` may invalidate the file.
Byron
reviewed
Apr 7, 2022
There was a problem hiding this comment.
Thanks a lot for the fix!
Regarding stdout/stderr: strip_newline might imply a newline is stripped universally, even though it applies to stdout only at the moment.
Maybe it should be called strip_newline_in_stdout to be specific while allowing to add a similar flag for stderr when there is a need?
PS: CI had issues but after restarting it the error now seems 'legit' (as it is upset about whitespace :/)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR adds the
strip_newlineflag to theGit.executemethod. When this flag is set toTrue, it will trim the trailing\n. The default value isTruefor backward compatibility. Setting it toFalseis helpful for, e.g., thegit showoutput, especially with the binary file, as the missing\nmay invalidate the file.Looking at the first some bytes and checking if the output is binary or not is another option to prevent making an invalid binary file. Still, I chose to add a parameter because it is easy to implement, is fully backward compatible, and doesn't add many lines to the source code.
Fixes: #1377
By the way, do we need to handle stderr too?