Use modify label on diffs & add right-arrow option #780
Conversation
When filtering a diff and when directly diffing files/dirs, use the modified label that is output when interpreting git diffs. This gets rid of the "comparing:" prefix (which was otherwise missing from the --navigate regex) and ensures that a direct diff has a label to stop at when --navigate is enabled. One of the unified-diff tests now uses --file-modified-label=comparing: to generate the same output as before, while the other now uses --navigate to get a delta char label.
This allows the file1 -> file2 arrow to be configured to whatever characters the user desires. The default is the same unicode arrow as before with 2 spaces after it, since this allows someone to remove the extra spaces that are in the current output.
| @@ -550,6 +550,10 @@ pub struct Opt { | |||
| /// Text to display in front of a renamed file path. | |||
| pub file_renamed_label: String, | |||
|
|
|||
| #[structopt(long = "right-arrow", default_value = "⟶ ")] | |||
There was a problem hiding this comment.
Note to self: there are two trailing spaces in this default value in order to match what was previously hard-coded in various places (whether or not the previous treatment was correct is a separate issue).
|
Hi @WayneD, thanks very much for this. I agree with both your changes. For example, having navigate work when comparing directory trees with Regarding the spaces after the right arrow, I don't know what's going on. I develop on MacOS using iTerm2 and I think that its handling of that right-arrow unicode character may be a little buggy. For example, if I paste
Now, if I enter two space characters, it looks like this:
However, I also see similar behavior using the default MacOS Terminal.app emulator: On paste (where has the head gone?!)
After entering two spaces:
I'm guessing you see more reasonable behavior with your terminal emulator(s)? |
|
When editing in vim, my cursor position is off-by-one on the line after the double-wide arrow char. So, moving the arrow into a single spot in the source files has the nice benefit of making the various format lines that output it easier to edit. That said, the arrow lines render fine (even in the editor), being shown with all the following characters after the arrow. I'm using the ChromeOS terminal into my Linux container. Here's the output of the old code vs the new where I've changed the right-arrow config to have no trailing spaces:
|
|
OK great. Not entirely sure whether we should change defaults, I guess it depends on the proportion of users' terminal emulators that are handling this correctly. Neither iTerm2 nor Terminal.app seem to. I've opened https://gitlab.com/gnachman/iterm2/-/issues/10058 (Is that vim as a desktop app, rather than a terminal app?) Thanks again for the PR! |
|
I use vim as an in-terminal editor (though it does have a gui mode as well). It's for people who like to edit in the old "vi" modal style but with lots of modern features (and I toss in some xemacs line editing into edit mode for good measure).So, it just seems to be unaware that some chars can render double-wide instead of single-wide (and thus it positions the cursor in the wrong spot). |
|
Incidentally, the iTerm2 author gave a very helpful explanation in https://gitlab.com/gnachman/iterm2/-/issues/10058:
|
|
Since it's such a problematical character, it seems better to switch to one that renders consistently. How about changing the default to be |
|
Hm, neither Chrome nor iTerm2 can render that character on my Mac. (Are you using Linux?)
|
This branch was inspired by my using delta to filter unified diffs and noticing that it was using a hard-wired "comparing:" label instead of the normal file-modified-label. This was aggravated by that heading not being in the default --navigate regex, so my n/N commands weren't stopping at it. I also noticed that having delta do the diff generation resulted in no label at all, not even with --navigate, which could not be fixed by a regex tweak. So, instead of adding the "comparing:" string to the navigate regex default, I decided to change the diff headings to use the modified label. While twiddling things I also decided to make the right-arrow configurable because I don't like how the ⟶ has 2 extra spaces on the right side (which might be needed by some shells?).
This branch has 2 commits on it:
I've tested the results and things look good to me. I've also run my changes through clippy and fmt to ensure that they're in good shape.