Add option to remove ANSI escape sequences from bat's input. #2999
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
eth-p
added
feature-request
eth-p
changed the title
eth-p
force-pushed
the
strip-ansi-from-input-option
branch
4 times, most recently
from
3f81db6
to
87b0c2e
Compare
eth-p
force-pushed
the
strip-ansi-from-input-option
branch
from
87b0c2e
to
7724541
Compare
eth-p
force-pushed
the
strip-ansi-from-input-option
branch
from
7724541
to
a678878
Compare
|
Rebased to c264ecd and fixed some clippy warnings. |
keith-hall
approved these changes
Jun 17, 2024
| @@ -759,9 +759,14 @@ bat() { | |||
|
|
|||
| If an input file contains color codes or other ANSI escape sequences or control characters, `bat` will have problems | |||
| performing syntax highlighting and text wrapping, and thus the output can become garbled. | |||
| When displaying such files it is recommended to disable both syntax highlighting and wrapping by | |||
|
|
|||
| If your version of `bat` supports the `--strip-ansi=auto` option, it can be used to remove such sequences | |||
There was a problem hiding this comment.
Interesting idea to add a hint about version in the readme, especially for features not part of a release yet 🙂
There was a problem hiding this comment.
It was relevant to the section, and I didn't want to forget to add it later. Had to word it so it didn't seem like it was already available, and that's what I came up with :)
When using `auto`, escape sequences will be stripped unless printing plain text.
eth-p
force-pushed
the
strip-ansi-from-input-option
branch
from
a678878
to
90dfa7f
Compare
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.
This pull request introduces a new
--strip-ansioption tobat.This option tells
batwhether to strip ANSI/VT escape sequences from the input file. The following values are supported:always: Always strip escape sequences.never: Never strip escape sequences. (default)auto: Strip escape sequences when printing any language that is not "Plain Text".This preserves bat's ability to print piped commands (or pre-highlighted files) and keep their existing colors.
Benchmarks
Disabled, Regular File
No significant difference.
Enabled, Regular File
A minor reduction in performance.
Disabled, Pre-highlighted File
No significant difference.
Enabled, Pre-highlighted File
It's certainly an improvement.
Auto Mode
The detection part of
--strip-ansi=autocauses no significant difference when syntax highlighting is used.However, it does add a few milliseconds of startup time when used with
--color=never. This is because--strip-ansi=autorelies on detecting the syntax in order to determine if a file is plain text or not (and thus whether to strip the ANSI sequences).TODO
SimplePrinter(maybe. thoughts?)Wait for Update bat's tab expansion preprocessor to use bat's ANSI escape sequence iterator. #2998.It contains the changes made in b4fe182, which this PR depends on.
Updatelong_helpintegration testWrite testsBenchmarksRuncargo fmtAllow--strip-ansito be passed multiple times (so it can be set to auto in config and overridden on the cli)