Customizable/configurable status line #2434

usagi-flow · 2022-05-08T19:57:07Z

Summary

Building upon the feedback of #2420 and the discussion in #708, I refactored the status line implementation and made it configurable.

The configuration happens in the user's configuration file and distinguishes between three areas of the status line: left, center and right.

[ ... ... LEFT ... ... | ... ... ... ... CENTER ... ... ... ... | ... ... RIGHT ... ... ]

Within each area, status line elements can be defined. There are no particular restrictions regarding the order, and elements can occur multiple times or be removed completely.

The following elements can currently be configured (see helix_view::editor::StatusLineElement):

mode
spinner
file-name
file-encoding
file-type
diagnostics
selections
position

Example

This would move the file name to the center, and add a file type indicated to the far right):

[editor.status-line]
left = ["mode", "spinner"]
center = ["file-name"]
right = ["diagnostics", "selections", "position", "file-encoding", "file-type"]

Additional info

The default configuration keeps the same status line layout with the same elements as before. While I do see room for improvement here, I assume it'd better be done in another PR.

On top of the elements which were already present, I added the implementation for one additional element: the file type (disabled by default).

archseer

This is great! I apologize it took me a while to review.

helix-term/src/ui/statusline.rs

mtoohey31 · 2022-06-15T03:05:41Z

Thanks for working on this, I just started using these changes and I'm loving the customizability already!

Not sure whether I should bring this up now, or wait until this is merged (or if this is even the right place for this discussion...), but I've written a "scope" element here that uses the language server's textDocument/documentSymbol method to display the struct/function/etc. that the cursor is inside, inspired by SmiteshP/nvim-navic. It's still a little rough; right now the icons are hard-coded to nerd-fonts icons, and I'm just triggering the request along with completion on idle, which might not be the right way to go about it, but cleaning things up shouldn't be too much work.

Is that something we'd be interested in supporting? And if so, should I hold on until after this is merged then create a separate PR, or is there another way I should go about things?

helix-term/src/ui/statusline.rs

sudormrfbin · 2022-06-16T03:30:14Z

@mtoohey31 I would recommend a separate PR that adds it as a new component; also we would want to avoid using nerd fonts by default (see #2211).

mtoohey31 · 2022-06-16T12:17:41Z

@mtoohey31 I would recommend a separate PR that adds it as a new component; also we would want to avoid using nerd fonts by default (see #2211).

Sounds good, I'll wait until this is merged then create one. And yep, I'll make sure to default to symbols that standard fonts will support. Thanks!

sbromberger · 2022-06-21T17:14:09Z

For the file type, could you make it configurable? I like seeing file type info but I don't want to take up multiple characters to show it. Having a config option that could override this default would allow me to use a glyph/icon without making assumptions about anyone else's font.

usagi-flow · 2022-06-22T15:07:02Z

For the file type, could you make it configurable? I like seeing file type info but I don't want to take up multiple characters to show it. Having a config option that could override this default would allow me to use a glyph/icon without making assumptions about anyone else's font.

Hmm, without introducing a dependency to devicons (or similar) in Helix, you would basically have to map filetypes to alternative labels (these can be single devicons) in your config; something like this:

[editor.status-line.file-type]
rust = "<devicon-here>"
javascript = "js"

It'd definitely be easy, but I think I'd first gather some extra input.
E.g. maybe we'd be open to an opt-in (i.e. disabled by default) configuration option devicons = "true". This would then allow us to map filetypes for you, and it would have the advantage of enabling devicons at many other places as well; not just in the statusline.

Either way, I believe it's worth opening a separate issue/discussion for this.

sbromberger · 2022-06-25T17:56:50Z

I'm currently blocked on #2862 (and, by extension, #2831). It'd be great to get this merged.

helix-view/src/editor.rs

helix-term/src/ui/statusline.rs

helix-view/src/editor.rs

sudormrfbin · 2022-06-26T18:03:36Z

Could you add a section to the docs at https://github.com/helix-editor/helix/blob/master/book/src/configuration.md#editor ?

usagi-flow · 2022-07-01T20:43:04Z

Thank you for the review, @sudormrfbin ! I extended the book a bit to include some configuration documentation (000a742 & 6699c05).
I corrected/changed the code according to the review as well; I do have one open remark regarding trait aliases, see above.

I'll soon rebase my commits because while this PR was open, #2676 was opened and merged, and conflicts with this PR's changes.

book/src/configuration.md

…struct

…ent functions

Avoid very small helper functions for the diagnositcs and inline them instead. Rename the config field `status_line` to `statusline` to remain consistent with `bufferline`.

…factoring

usagi-flow · 2022-07-05T20:08:29Z

Alright, I rebased the branch and reintegrated the last few bits of #2676 in 8d28f95. All looks good and clippy is happy! :)

helix-term/src/ui/statusline.rs

Because none of the functions need `Self` and all of them are in an own file, there is no explicit need for the struct.

usagi-flow · 2022-07-06T16:29:14Z

As a friendly side note: I don't mind refactoring more of this after the PR was merged, even if it's just cosmetic code changes! :)

Not that I mind doing so now, but we're starting to block some other features which build upon this, and there's always the risk that we have to rebase onto more changes like #2676.

helix-term/src/ui/statusline.rs

The configuration was ignored after reintegrating the changes of #2676 in 8d28f95.

helix-term/src/ui/statusline.rs

pickfire · 2022-07-13T14:55:40Z

helix-term/src/ui/statusline.rs

+    // Left side of the status line.
+
+    let element_ids = &context.editor.config().statusline.left;
+    element_ids
+        .iter()
+        .map(|element_id| get_render_function(*element_id))
+        .for_each(|render| render(context, write_left));
+
+    surface.set_spans(
+        viewport.x,
+        viewport.y,
+        &context.parts.left,
+        context.parts.left.width() as u16,
+    );


These parts seemed to be duplicated a bit. Is it better to refactor it?

Hm, do you mean something like introducing a function like the following and calling it in render()?

fn render_area(element_ids: &Vec<StatusLineElement>, write: F, x: u16, y: y16) where F: Fn(&mut RenderContext, String, Option<Style>) + Copy

archseer

Tested and looks fine, I just have one nit about the styling not matching current master

helix-term/src/ui/statusline.rs

archseer

Tested, works great! Thanks for working on this :)

* feat(statusline): add the file type (language id) to the status line * refactor(statusline): move the statusline implementation into an own struct * refactor(statusline): split the statusline implementation into different functions * refactor(statusline): Append elements using a consistent API This is a preparation for the configurability which is about to be implemented. * refactor(statusline): implement render_diagnostics() This avoid cluttering the render() function and will simplify configurability. * feat(statusline): make the status line configurable * refactor(statusline): make clippy happy * refactor(statusline): avoid intermediate StatusLineObject Use a more functional approach to obtain render functions and write to the buffers, and avoid an intermediate StatusLineElement object. * fix(statusline): avoid rendering the left elements twice * refactor(statusline): make clippy happy again * refactor(statusline): rename `buffer` into `parts` * refactor(statusline): ensure the match is exhaustive * fix(statusline): avoid an overflow when calculating the maximal center width * chore(statusline): Describe the statusline configurability in the book * chore(statusline): Correct and add documentation * refactor(statusline): refactor some code following the code review Avoid very small helper functions for the diagnositcs and inline them instead. Rename the config field `status_line` to `statusline` to remain consistent with `bufferline`. * chore(statusline): adjust documentation following the config field refactoring * revert(statusline): revert regression introduced by c0a1870 * chore(statusline): slight adjustment in the configuration documentation * feat(statusline): integrate changes from helix-editor#2676 after rebasing * refactor(statusline): remove the StatusLine struct Because none of the functions need `Self` and all of them are in an own file, there is no explicit need for the struct. * fix(statusline): restore the configurability of color modes The configuration was ignored after reintegrating the changes of helix-editor#2676 in 8d28f95. * fix(statusline): remove the spinner padding * refactor(statusline): remove unnecessary format!()

usagi-flow mentioned this pull request May 9, 2022

Configurable status line location #1749

Closed

the-mikedavis added the S-waiting-on-review Status: Awaiting review from a maintainer. label May 18, 2022

This was referenced May 18, 2022

Add the file type (language id) to the status line #2420

Closed

feat: show filetype and filetype icon and lsp name in statusline #2211

Closed

archseer reviewed May 20, 2022

View reviewed changes

helix-term/src/ui/statusline.rs Outdated Show resolved Hide resolved

the-mikedavis removed the S-waiting-on-review Status: Awaiting review from a maintainer. label May 20, 2022

archseer mentioned this pull request May 20, 2022

Add total line info to statusline #649

Closed

litchipi mentioned this pull request May 30, 2022

helix-term: ui: Refactor statusline rendering, set configurable #2610

Closed

the-mikedavis mentioned this pull request May 31, 2022

Usability enhancement (status line): place file status indicator before file name not after it #2582

Closed

pickfire reviewed Jun 8, 2022

View reviewed changes

helix-term/src/ui/statusline.rs Outdated Show resolved Hide resolved

pickfire reviewed Jun 8, 2022

View reviewed changes

helix-term/src/ui/statusline.rs Outdated Show resolved Hide resolved

the-mikedavis mentioned this pull request Jun 13, 2022

:w selects the whole file, thus losing caret placement. #2752

Closed

mtoohey31 reviewed Jun 15, 2022

View reviewed changes

helix-term/src/ui/statusline.rs Outdated Show resolved Hide resolved

archseer requested a review from sudormrfbin June 22, 2022 10:18

lazytanuki mentioned this pull request Jun 23, 2022

feat: icon support #2869

Open

15 tasks

the-mikedavis mentioned this pull request Jun 25, 2022

add customizable read-only indicator to statusbar #2862

Closed

sudormrfbin reviewed Jun 26, 2022

View reviewed changes

EpocSquadron mentioned this pull request Jun 30, 2022

feat(line-numbers): add total line numbers to position content #2921

Closed

sudormrfbin reviewed Jul 2, 2022

View reviewed changes

book/src/configuration.md Outdated Show resolved Hide resolved

usagi-flow added 3 commits July 5, 2022 21:16

feat(statusline): add the file type (language id) to the status line

da5a886

refactor(statusline): move the statusline implementation into an own …

bf691a1

…struct

refactor(statusline): split the statusline implementation into differ…

73d6f34

…ent functions

usagi-flow added 5 commits July 5, 2022 21:40

chore(statusline): Correct and add documentation

2dc4d34

refactor(statusline): refactor some code following the code review

5cb4e76

Avoid very small helper functions for the diagnositcs and inline them instead. Rename the config field `status_line` to `statusline` to remain consistent with `bufferline`.

chore(statusline): adjust documentation following the config field re…

42654fd

…factoring

revert(statusline): revert regression introduced by c0a1870

aa8c467

chore(statusline): slight adjustment in the configuration documentation

28fa36f

usagi-flow force-pushed the feat-statusline branch from 5621494 to 28fa36f Compare July 5, 2022 20:04

feat(statusline): integrate changes from #2676 after rebasing

8d28f95

pickfire reviewed Jul 6, 2022

View reviewed changes

helix-term/src/ui/statusline.rs Outdated Show resolved Hide resolved

refactor(statusline): remove the StatusLine struct

fae2348

Because none of the functions need `Self` and all of them are in an own file, there is no explicit need for the struct.

Mathspy reviewed Jul 6, 2022

View reviewed changes

helix-term/src/ui/statusline.rs Outdated Show resolved Hide resolved

fix(statusline): restore the configurability of color modes

2cb20ff

The configuration was ignored after reintegrating the changes of #2676 in 8d28f95.

yuanyelele reviewed Jul 7, 2022

View reviewed changes

helix-term/src/ui/statusline.rs Show resolved Hide resolved

Mathspy mentioned this pull request Jul 7, 2022

Fix Document::language_id returning None if there is no lang server #2998

Closed

the-mikedavis mentioned this pull request Jul 12, 2022

Add :show-language command #3047

Closed

pickfire reviewed Jul 13, 2022

View reviewed changes

archseer requested changes Jul 15, 2022

View reviewed changes

helix-term/src/ui/statusline.rs Outdated Show resolved Hide resolved

helix-term/src/ui/statusline.rs Show resolved Hide resolved

usagi-flow added 2 commits July 17, 2022 12:31

fix(statusline): remove the spinner padding

dba88ba

refactor(statusline): remove unnecessary format!()

7ddb5fe

archseer approved these changes Jul 18, 2022

View reviewed changes

archseer merged commit dbf68e0 into helix-editor:master Jul 18, 2022

axdank mentioned this pull request Jul 19, 2022

Elements in the status line are not separated, leading to a very cluttered result #3106

Closed

sbromberger mentioned this pull request Jul 23, 2022

allow customization of file type in statusbar #3164

Closed

This was referenced Nov 10, 2022

Customizable statusline #708

Closed

It should be possible to tell there are unsaved changes to the buffer, even with long file paths. #4686

Closed

usagi-flow mentioned this pull request Mar 26, 2023

Customizable statusbar - multiple separators and colors #5868

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Customizable/configurable status line #2434

Customizable/configurable status line #2434

usagi-flow commented May 8, 2022

archseer left a comment

mtoohey31 commented Jun 15, 2022

sudormrfbin commented Jun 16, 2022

mtoohey31 commented Jun 16, 2022

sbromberger commented Jun 21, 2022 •

edited

usagi-flow commented Jun 22, 2022 •

edited

sbromberger commented Jun 25, 2022

sudormrfbin commented Jun 26, 2022 •

edited

usagi-flow commented Jul 1, 2022 •

edited

usagi-flow commented Jul 5, 2022

usagi-flow commented Jul 6, 2022

pickfire Jul 13, 2022

usagi-flow Jul 17, 2022

archseer left a comment

archseer left a comment

Customizable/configurable status line #2434

Customizable/configurable status line #2434

Conversation

usagi-flow commented May 8, 2022

Summary

Example

Additional info

archseer left a comment

Choose a reason for hiding this comment

mtoohey31 commented Jun 15, 2022

sudormrfbin commented Jun 16, 2022

mtoohey31 commented Jun 16, 2022

sbromberger commented Jun 21, 2022 • edited

usagi-flow commented Jun 22, 2022 • edited

sbromberger commented Jun 25, 2022

sudormrfbin commented Jun 26, 2022 • edited

usagi-flow commented Jul 1, 2022 • edited

usagi-flow commented Jul 5, 2022

usagi-flow commented Jul 6, 2022

pickfire Jul 13, 2022

Choose a reason for hiding this comment

usagi-flow Jul 17, 2022

Choose a reason for hiding this comment

archseer left a comment

Choose a reason for hiding this comment

archseer left a comment

Choose a reason for hiding this comment

sbromberger commented Jun 21, 2022 •

edited

usagi-flow commented Jun 22, 2022 •

edited

sudormrfbin commented Jun 26, 2022 •

edited

usagi-flow commented Jul 1, 2022 •

edited