Add rulers option #2060

DeviousStoat · 2022-04-10T12:05:50Z

Attempts at a solution for #1897

This adds a rulers option which is a list of column positions at which a color column should be drawn.
I added a ui.virtual.ruler theme value to set the theme of the color column. I am not sure if this is the best solution. I think this would need to be added to every theme.

I initially wanted to add the cursor column to this option as well but I thought it would be better as a different option as this needs to be drawn only on the focused window. And I didn't really find a good way to specify it in the option. I will probably open another PR for this soon if this sounds good to you.

The cool thing using the theme system is that we can set only the foreground color for the colorcolumn and I think it is actually really cool:

With rulers = [20] and "ui.virtual.ruler" = "red"

sudormrfbin · 2022-04-10T18:00:38Z

An alternate name could be "ruler" instead of vim's colorcolumn.

pickfire · 2022-04-12T23:52:14Z

helix-term/src/ui/editor.rs

+                    })
+                    .filter(|area| area.left() < inner.right())
+            })
+            .for_each(|area| surface.set_style(area, theme.get("ui.colorcolumn")));


I think we can probably default this to red.

There's already ui.highlight that can be used.

I'd scope this as ui.highlight.ruler so that it can be styled independently but have a fallback

This is so neat! This dot notation fallback system is very powerful.
I allowed myself to add ui.highlight along with the new ui.highlight.ruler in the list of available theme keys in the documentation as I think it was missing.

helix-term/src/ui/editor.rs

pickfire · 2022-04-12T23:56:50Z

book/src/configuration.md

@@ -42,6 +42,7 @@ hidden = false
 | `completion-trigger-len` | The min-length of word under cursor to trigger autocompletion | `2` |
 | `auto-info` | Whether to display infoboxes | `true` |
 | `true-color` | Set to `true` to override automatic detection of terminal truecolor support in the event of a false negative. | `false` |
+| `color-column` | List of column positions at which to display the color columns. | `[]` |


I don't think this should be in editor but in languages.toml, people might want to set a different color column for different themes? For example, rust might have one on 80 and one on 100. Or maybe we can have this on both side?

This sounds very useful but I personally really like having a global color column. It would be tedious to have to set it up for each language. So I tried to go with both. The language one having the priority but falling back to the editor one if not set.

pickfire · 2022-04-13T00:00:33Z

An alternate name could be "ruler" instead of vim's colorcolumn.

Where do you see that being used? I think ruler might be a bit confusing since people might mistake it for line number.

archseer · 2022-04-13T00:52:15Z

An alternate name could be "ruler" instead of vim's colorcolumn.

ruler is actually a different thing: https://codeyarns.com/tech/2010-11-28-vim-ruler-and-default-ruler-format.html

sudormrfbin · 2022-04-13T02:00:53Z

I picked ruler straight from VSCode (seems like sublime does too), and it sounds more clearer in intent IMO as something used to draw straight lines (vertical lines here). And we do deviate from vim's naming scheme where it makes sense (eg. cursor-shape vs nvim's guicursor).

the-mikedavis · 2022-04-13T02:10:51Z

I think ruler is a strange name for that widget in vim. To me ruler implies some straight line you might use for alignment (or measurement I suppose) which fits better with this feature

archseer · 2022-04-13T04:10:21Z

Okay I agree, let's rename this to ruler/rulers

archseer

Looks good to me 👍

archseer · 2022-04-17T03:12:23Z

Ah, looks like there's a small conflict, can you resolve?

sudormrfbin · 2022-04-17T03:53:04Z

book/src/themes.md

+| `ui.highlight`           |                                     |
+| `ui.highlight.ruler`     |                                     |


The ui.virtual namespace used in #1802 and #1796 might be a better fit here.

sudormrfbin · 2022-04-17T04:27:51Z

helix-term/src/ui/editor.rs

+        rulers
+            .iter()
+            .filter_map(|ruler| {
+                ruler
+                    .checked_sub(1 + view.offset.col as u16)
+                    .map(|x| {
+                        viewport
+                            .with_height((view.last_line(doc) - view.offset.row + 1) as u16)
+                            .clip_left(x)
+                            .with_width(1)
+                    })
+                    .filter(|area| area.left() < viewport.right())
+            })
+            .for_each(|area| surface.set_style(area, theme.get("ui.highlight.ruler")));


Suggested change

rulers

.iter()

.filter_map(|ruler| {

ruler

.checked_sub(1 + view.offset.col as u16)

.map(|x| {

viewport

.with_height((view.last_line(doc) - view.offset.row + 1) as u16)

.clip_left(x)

.with_width(1)

})

.filter(|area| area.left() < viewport.right())

})

.for_each(|area| surface.set_style(area, theme.get("ui.highlight.ruler")));

rulers

.iter()

// View might be horizontally scrolled, convert from absolute distance

// from the 1st column to relative distance from left of viewport

.filter_map(|ruler| ruler.checked_sub(1 + view.offset.col as u16))

.filter(|ruler| ruler < &viewport.width)

.map(|ruler| viewport.clip_left(ruler).with_width(1))

.for_each(|area| surface.set_style(area, theme.get("ui.highlight.ruler")))

I'd also pull out the theme.get call so we're not re-fetching on every iteration

Thank you! This looks a lot nicer! There is just one thing I am wondering about. You dropped the with_height. Is that on purpose? Because it draws the ruler on the whole screen instead of stopping at the last line of text

Is that the wanted behaviour?

Isn't it a bit nicer with .map(|ruler| viewport.clip_left(ruler).with_width(1).with_height((view.last_line(doc) - view.offset.row + 1) as u16)?

I personally like the version which extends to the whole screen since it feels consistent (not a strong argument for a vertical colored line I know :)

From the rulers feature (#2060)

DeviousStoat force-pushed the color-columns branch from e0ff297 to ede0791 Compare April 10, 2022 12:35

pickfire reviewed Apr 12, 2022

View reviewed changes

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

pickfire reviewed Apr 12, 2022

View reviewed changes

DeviousStoat force-pushed the color-columns branch 2 times, most recently from 44f5cdc to ecd5f7b Compare April 14, 2022 01:02

archseer approved these changes Apr 17, 2022

View reviewed changes

sudormrfbin reviewed Apr 17, 2022

View reviewed changes

Add color_column option

5b1b815

DeviousStoat force-pushed the color-columns branch from ecd5f7b to c049e97 Compare April 17, 2022 18:00

Rename to ruler

98adf55

DeviousStoat force-pushed the color-columns branch from c049e97 to 98adf55 Compare April 17, 2022 18:04

DeviousStoat changed the title ~~Add color_column option~~ Add rulers option Apr 17, 2022

archseer merged commit 5d5b6ba into helix-editor:master Apr 20, 2022

This was referenced Apr 20, 2022

Add Pop-Dark Theme #2189

Merged

Document ui.virtual.ruler scope in theme docs #2199

Merged

sudormrfbin pushed a commit that referenced this pull request Apr 20, 2022

Document ui.virtual.ruler scope in theme docs (#2199)

6de2e76

From the rulers feature (#2060)

the-mikedavis mentioned this pull request Aug 24, 2022

Support column highlighting #1897

Closed

luetage mentioned this pull request Jan 18, 2023

Attempting to fix rulers/cursor highlighting #5568

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add rulers option #2060

Add rulers option #2060

DeviousStoat commented Apr 10, 2022 •

edited

sudormrfbin commented Apr 10, 2022

pickfire Apr 12, 2022

archseer Apr 13, 2022

archseer Apr 13, 2022

DeviousStoat Apr 14, 2022 •

edited

pickfire Apr 12, 2022 •

edited

DeviousStoat Apr 14, 2022 •

edited

pickfire commented Apr 13, 2022

archseer commented Apr 13, 2022

sudormrfbin commented Apr 13, 2022

the-mikedavis commented Apr 13, 2022

archseer commented Apr 13, 2022 •

edited

archseer left a comment

archseer commented Apr 17, 2022

sudormrfbin Apr 17, 2022

sudormrfbin Apr 17, 2022

archseer Apr 17, 2022

DeviousStoat Apr 17, 2022

sudormrfbin Apr 17, 2022

Add rulers option #2060

Add rulers option #2060

Conversation

DeviousStoat commented Apr 10, 2022 • edited

sudormrfbin commented Apr 10, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DeviousStoat Apr 14, 2022 • edited

Choose a reason for hiding this comment

pickfire Apr 12, 2022 • edited

Choose a reason for hiding this comment

DeviousStoat Apr 14, 2022 • edited

Choose a reason for hiding this comment

pickfire commented Apr 13, 2022

archseer commented Apr 13, 2022

sudormrfbin commented Apr 13, 2022

the-mikedavis commented Apr 13, 2022

archseer commented Apr 13, 2022 • edited

archseer left a comment

Choose a reason for hiding this comment

archseer commented Apr 17, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DeviousStoat commented Apr 10, 2022 •

edited

DeviousStoat Apr 14, 2022 •

edited

pickfire Apr 12, 2022 •

edited

DeviousStoat Apr 14, 2022 •

edited

archseer commented Apr 13, 2022 •

edited