feat: Show filepath context in bufferline #13565
Open
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
icorbrey
force-pushed
the
feat/bufferline-context
branch
from
99a23ae to
0676f6a
Compare
LucasWagler
reviewed
May 18, 2025
icorbrey
force-pushed
the
feat/bufferline-context
branch
2 times, most recently
from
1abbf96 to
7d43d39
Compare
CalebLarsen
reviewed
May 21, 2025
CalebLarsen
reviewed
May 21, 2025
CalebLarsen
reviewed
May 21, 2025
CalebLarsen
reviewed
May 21, 2025
icorbrey
force-pushed
the
feat/bufferline-context
branch
2 times, most recently
from
8165ca5 to
eecd9ae
Compare
CalebLarsen
approved these changes
May 21, 2025
DerSaidin
reviewed
Jun 6, 2025
|
Related: #13113 |
icorbrey
force-pushed
the
feat/bufferline-context
branch
from
eecd9ae to
9183108
Compare
DerSaidin
reviewed
Jun 10, 2025
| /// editor. For example, documents `a/b` and `c/d` would resolve to `b` and `d` | ||
| /// respectively, while `a/b/c` and `a/d/c` would resolve to `b/c` and `d/c` | ||
| /// respectively. | ||
| fn expand_fname_contexts<'a>(editor: &'a Editor, scratch: &'a str) -> HashMap<DocumentId, String> { |
There was a problem hiding this comment.
Instead of taking editor, could this take less context?
e.g. pass in documents: BTreeMap<DocumentId, Document>, or possibly just the Option, not the whole Document.
Related: could this function have a unit test below?
There was a problem hiding this comment.
Re: unit test, it probably could but I wasn't sure if it would be a value add for the project. There seem to be very few unit tests in here.
There was a problem hiding this comment.
Imo tests are good, and adding tests is better than not :)
This change adds functionality that computes the shortest unique filepath for each document in the editor to display as the title in the bufferline, along with the appropriate configuration options.
icorbrey
force-pushed
the
feat/bufferline-context
branch
from
9183108 to
bc0f718
Compare
DerSaidin
approved these changes
Jun 11, 2025
| /// editor. For example, documents `a/b` and `c/d` would resolve to `b` and `d` | ||
| /// respectively, while `a/b/c` and `a/d/c` would resolve to `b/c` and `d/c` | ||
| /// respectively. | ||
| fn expand_fname_contexts<'a>(editor: &'a Editor, scratch: &'a str) -> HashMap<DocumentId, String> { |
There was a problem hiding this comment.
Imo tests are good, and adding tests is better than not :)
|
@the-mikedavis I don't know who to ask, but could I get checks run on my PR? |
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 change adds functionality that computes the shortest unique filepath for each document in the editor to display as the title in the bufferline, along with the appropriate configuration options.
Configuration changes
editor.bufferlinehas been moved toeditor.bufferline.show, and a new keyeditor.bufferline.contexthas been added with the following variants:"none": Don't provide any additional context in the bufferline. This maintains previous functionality."minimal": Show the shortest unique filepath for each document in the bufferline. This is the new default.Setting the render mode directly in
editor.bufferlineis still supported, so existing configs won't break.Functionality
With
editor.bufferline.context = "none", the following set of documents is mapped as follows:book/src/editor.mdeditor.mdhelix-term/src/ui/editor.rseditor.rshelix-view/src/editor.rseditor.rsWith
editor.bufferline.context = "minimal", the same set of documents is now mapped as follows:book/src/editor.mdeditor.mdhelix-term/src/ui/editor.rsui/editor.rshelix-view/src/editor.rssrc/editor.rsVerification steps
editor.bufferline.showtoalways.editor.bufferline.contexttonone.Possible additions
We could add another context variant
"full"which would map documents to their full path (either from Helix's working directory or, if outside that, from the user's home directory (e.g.~/...) or from the system root (e.g./...).