feat: current indent #743

lukas-reineke · 2023-10-20T07:38:17Z

@Danielkonge I finally had some proper time to go over your PR.

Like I mentioned before, I did some pretty extensive refactor. Your code was good, but there were things I wanted to do a bit differently.

Instead of having a new current_indent_stack, I reused indent_state
I wasn't able to explain this properly, but I change the behavior of show_end for current indent to match scope better
Some bugfixes, for example inlay hints
I added exclude and hooks for current indent

Can you take a look at this? It's very likely I broke something that was working in your version.

Co-authored-by: Lukas Reineke <[email protected]> Co-authored-by: Daniel Kongsgaard <[email protected]>

Danielkonge

I have written some comments now. I will try to use this a bit and go through the code more thoroughly to see if notice anything else.

doc/indent_blankline.txt

lua/ibl/init.lua

lua/ibl/utils.lua

lua/ibl/hooks.lua

Danielkonge · 2023-10-20T11:51:52Z

In my files with spaces for tabs I haven't noticed any problems, but when using actual tabs, current_indent has some problems (see picture).

The problem seems to be when you go back multiple indent levels at once.

lukas-reineke · 2023-10-20T13:06:27Z

yeah... no this doesn't work
it's completely broken with tabs or without smart_indent_cap when the indent changes by more than one

I'll try to rewrite it again next week

Danielkonge · 2023-10-20T13:22:55Z

Just a clarifying note: I noticed that it is actually going multiple indents in at once that is the problem. Not going multiple indents back.

Danielkonge · 2023-10-20T11:09:27Z

lua/ibl/highlights.lua

@@ -46,6 +49,9 @@ local setup_builtin_hl_groups = function()
    if not_set(get(ibl_scope_hl_name)) then
        vim.api.nvim_set_hl(0, ibl_scope_hl_name, line_nr_hl)
    end
+    if not_set(get(ibl_current_indent_hl_name)) then
+        vim.api.nvim_set_hl(0, ibl_current_indent_hl_name, line_nr_hl)


I think that the highlights from "CursorLineNr" (or maybe just white) makes more sense here as the default highlight for current_indent. I know it might not be set for everyone, but we could use this as a backup then instead. This would (when it is set) make it easier to distinguish between scope and current_indent for people trying out both.

Alternatively, it might be a better idea to just add an example with "CursorLineNr" as the highlight group for current_indent in the docs, since I feel like that might be a common highlight choice.

Danielkonge · 2023-10-20T13:45:08Z

lua/ibl/init.lua

+                if indent_state.stack[j].indent < current_indent_col_start_single then
+                    break
+                end
+                current_indent.start_row = indent_state.stack[j].row + 1


Suggested change

if indent_state.stack[j].indent < current_indent_col_start_single then

break

end

current_indent.start_row = indent_state.stack[j].row + 1

current_indent.start_row = indent_state.stack[j].row + 1

if indent_state.stack[j].indent <= current_indent_col_start_single then

break

end

This partially fixes the problem with multiple indents for me (I will make another note to fix the other problem).

Danielkonge · 2023-10-20T13:47:02Z

lua/ibl/init.lua

+                and config.scope.priority >= config.current_indent.priority
+            )
+        then
+            vim.api.nvim_buf_set_extmark(bufnr, namespace, row - 1, current_indent_col_start_single, {


Suggested change

vim.api.nvim_buf_set_extmark(bufnr, namespace, row - 1, current_indent_col_start_single, {

vim.api.nvim_buf_set_extmark(bufnr, namespace, row - 1, #whitespace, {

We need to start highlights after the whitespace here (any highlights before the whitespace ends is already taken care of in the virtual text overlay). [Note: The code before the suggestion doesn't work with tabs since it depends on the whitespace_tbl instead of whitespace.]

Together with the above fix, this fixes the multiple indent level jumps problem for me (based on my testing so far).

Danielkonge · 2023-10-20T13:48:46Z

The two suggested fixes managed to fix the above problem for me (but I need to test it more).

Danielkonge · 2023-10-20T17:57:12Z

doc/indent_blankline.txt

+ The scope is *not* the current indentation level!
+ See |ibl.config.current_indent| if you want to highlight the current
+ indentation.
+ Instead, scope it is the indentation level where variables or functions


Suggested change

Instead, scope it is the indentation level where variables or functions

Instead, scope is the indentation level where variables or functions

Danielkonge · 2023-10-20T18:03:17Z

lua/ibl/config.types.lua

@@ -131,6 +155,8 @@
 ---@field whitespace ibl.config.full.whitespace: ibl.config.whitespace
 --- Configures the scope
 ---@field scope ibl.config.full.scope: ig.config.scope


Suggested change

---@field scope ibl.config.full.scope: ig.config.scope

---@field scope ibl.config.full.scope: ibl.config.scope

Danielkonge · 2023-10-21T14:27:43Z

Another small note: While doing a lot of undos in a larger file, I got the following error:

Error executing lua callback: ...nal/nvim-plugins/indent-blankline.nvim/lua/ibl/utils.lua:264: attempt to perform arithmetic on a nil value

[Update: I figured out a way to reproduce the problem, and it was not with undos. I have submitted a fix below.]

Danielkonge · 2023-10-24T22:18:09Z

Small note:
I now have this problem, where current_indent.show_start shows the start above an empty line at the end of the file (only if the empty line is the last line of the file). If you haven't looked at this by tomorrow, I will try to get back with a fix for it by then.

Update: See the comment below for a solution.

Danielkonge

GitHub won't let me put this comment in the code for some reason, but there is a problem at line 328 of init.lua.

            if i == #lines then
                whitespace_tbl = {}

we need to do something with the indent_state too, otherwise current_indent.show_start will mistakenly highlight the line above the last line of the code (if the last line is empty).

            if i == #lines then
                whitespace_tbl, indent_state = indent.get(whitespace, indent_opts, indent_state, row)

works, but I am not sure if that is the best way to do it. Maybe it is better to set it explicitly. Will the last line ever be visible if it is not the last line of the file? If not, we could just set indent_state.stack = {{ indent = 0, row = row }} in that if statement.

Danielkonge

Here is a fix to a problem giving the following error.

Error executing lua callback: ...nal/nvim-plugins/indent-blankline.nvim/lua/ibl/utils.lua:264: attempt to perform arithmetic on a nil value

Danielkonge · 2023-10-27T19:51:00Z

lua/ibl/utils.lua

+    local end_pos_col
+
+    if end_line[1] then
+        end_pos = vim.inspect_pos(bufnr, end_row, end_line[1]:find "%S" - 1, {


Suggested change

end_pos = vim.inspect_pos(bufnr, end_row, end_line[1]:find "%S" - 1, {

local end_pos_find = #end_line[1] - 1

local try_find = end_line[1]:find "%S"

if try_find then

end_pos_find = try_find - 1

end

end_pos = vim.inspect_pos(bufnr, end_row, end_pos_find, {

The current code causes problems when find returns nil sometimes.

Danielkonge · 2023-11-09T14:32:01Z

Just a quick update. I have used a fork of this with the fixes I describe above for a couple of weeks now. I have been editing files with both tabs and spaces for indentation, and I haven't noticed any other problems.

mehalter · 2023-11-09T15:02:28Z

@Danielkonge could you link the fork you have been using? I would be interested in giving it a try!

Danielkonge · 2023-11-09T15:20:52Z

@Danielkonge could you link the fork you have been using? I would be interested in giving it a try!

It's this fork: https://github.com/Danielkonge/indent-blankline.nvim/tree/current_indent_final

Note that this doesn't include any of the fixes that has been committed to the master branch in the last couple of weeks. This is mainly to test out current_indent.

Other than some comments the only real difference between the fork and this pull request is on lines: 328, 407-410 and 573 in init.lua and then lines 270-275 in utils.lua.

mehalter · 2023-11-09T15:24:16Z

No problem! I am just interested in investigating the current_indent feature. AstroNvim is about to do a major version release and I'm looking to see if we can wait for this PR and drop the need for mini.indentscope for highlighting the current indent level. Thanks so much for all your work for this! I've been following your development and PRs leading up to this :)

Danielkonge

I found one more issue. I think this should fix it.

The previous code had this behavior:

My change gives this behavior:

Danielkonge · 2023-11-12T22:08:00Z

lua/ibl/init.lua

+            current_indent_enabled
+            and config.current_indent.show_end
+            and is_current_indent_end
+            and #whitespace_tbl > current_indent_col_start_single


Suggested change

and #whitespace_tbl > current_indent_col_start_single

and current_indent.start_row <= row

and #whitespace_tbl > current_indent_col_start_single

until those PRs gets merged AstroNvim/AstroNvim#2365 lukas-reineke/indent-blankline.nvim#743

lukas-reineke · 2023-12-06T00:35:24Z

Just a quick update, I am still planning on merging this. But it needs more polish, and I am very short on time at the moment.

mehalter · 2023-12-06T00:55:53Z

Thanks for the update, looking forward to this improvement! Appreciate all your work on this!

lukas-reineke · 2023-12-15T03:23:02Z

@Danielkonge Sounds good, but please make it a separate PR.

mehalter · 2024-09-06T08:33:39Z

Hey! Just wanted to check in and see if this PR is still planned on getting merged at some point :)

lukas-reineke · 2024-09-07T02:03:43Z

It is still planned. Unfortunately, my situation hasn't changed much. This year has been super busy, I just don't have that much time for open source.
New feature development like this will have to wait a bit more.

jdelgadofrts · 2024-10-16T18:59:31Z

For whatever is worth, this would be an amazing feature to add. I love the notion of just having guideline essentially highlighted for the current indentation.

It solves a lot of visual noise that can happen, specially around rainbow guidelines.

Open source is pretty ungrateful, so regardless, this is an amazing plugin, and thank you for your hard work!

lukas-reineke self-assigned this Oct 20, 2023

feat: current indent

ae26f0c

Co-authored-by: Lukas Reineke <[email protected]> Co-authored-by: Daniel Kongsgaard <[email protected]>

lukas-reineke force-pushed the current-indent branch from 70bbdf3 to ae26f0c Compare October 20, 2023 07:51

Danielkonge reviewed Oct 20, 2023

View reviewed changes

lukas-reineke marked this pull request as draft October 20, 2023 13:06

fixup! feat: current indent

0717a01

Danielkonge reviewed Oct 20, 2023

View reviewed changes

Danielkonge mentioned this pull request Oct 20, 2023

Lazy Configuration (example) #742

Closed

Danielkonge reviewed Oct 20, 2023

View reviewed changes

Danielkonge reviewed Oct 25, 2023

View reviewed changes

Danielkonge mentioned this pull request Oct 26, 2023

Highlight current indent (no color) with a lower priority than scope (with color) #649

Open

Danielkonge reviewed Oct 27, 2023

View reviewed changes

wookayin mentioned this pull request Nov 2, 2023

Fast current_indent (resolves #649) #726

Closed

This was referenced Nov 4, 2023

How to change the highlight color for indent line of the current context ? #765

Closed

Bad indentation of scope for multi-line function definition #752

Closed

This was referenced Nov 9, 2023

feat(indent-blankline): use new current indent level indicator AstroNvim/AstroNvim#2365

Closed

feat(indent-blankline): add new IblCurrentIndent highlight group AstroNvim/astrotheme#95

Draft

Danielkonge reviewed Nov 12, 2023

View reviewed changes

RayJameson added a commit to RayJameson/astronvim_config that referenced this pull request Dec 4, 2023

feat(indent): temporary add mini-indenscope

c758aa9

until those PRs gets merged AstroNvim/AstroNvim#2365 lukas-reineke/indent-blankline.nvim#743

RayJameson added a commit to RayJameson/astronvim_config that referenced this pull request Dec 4, 2023

feat(indent): temporary add mini-indenscope

d647bda

until those PRs gets merged AstroNvim/AstroNvim#2365 lukas-reineke/indent-blankline.nvim#743

This comment was marked as resolved.

Sign in to view

Danielkonge mentioned this pull request Dec 30, 2023

Attempt to perform arithmetic on a nil value #814

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: current indent #743

feat: current indent #743

lukas-reineke commented Oct 20, 2023

Danielkonge left a comment

Danielkonge commented Oct 20, 2023 •

edited

Loading

lukas-reineke commented Oct 20, 2023

Danielkonge commented Oct 20, 2023

Danielkonge Oct 20, 2023

Danielkonge Oct 20, 2023 •

edited

Loading

Danielkonge Oct 20, 2023 •

edited

Loading

Danielkonge commented Oct 20, 2023

Danielkonge Oct 20, 2023

Danielkonge Oct 20, 2023

Danielkonge commented Oct 21, 2023 •

edited

Loading

Danielkonge commented Oct 24, 2023 •

edited

Loading

Danielkonge left a comment •

edited

Loading

Danielkonge left a comment

Danielkonge Oct 27, 2023 •

edited

Loading

Danielkonge commented Nov 9, 2023 •

edited

Loading

mehalter commented Nov 9, 2023

Danielkonge commented Nov 9, 2023

mehalter commented Nov 9, 2023

Danielkonge left a comment

Danielkonge Nov 12, 2023

lukas-reineke commented Dec 6, 2023

mehalter commented Dec 6, 2023

This comment was marked as resolved.

lukas-reineke commented Dec 15, 2023

mehalter commented Sep 6, 2024

lukas-reineke commented Sep 7, 2024

jdelgadofrts commented Oct 16, 2024

	vim.api.nvim_buf_set_extmark(bufnr, namespace, row - 1, current_indent_col_start_single, {
	vim.api.nvim_buf_set_extmark(bufnr, namespace, row - 1, #whitespace, {

	Instead, scope it is the indentation level where variables or functions
	Instead, scope is the indentation level where variables or functions

	---@field scope ibl.config.full.scope: ig.config.scope
	---@field scope ibl.config.full.scope: ibl.config.scope

-        end_pos = vim.inspect_pos(bufnr, end_row, end_line[1]:find "%S" - 1, {
+        local end_pos_find = #end_line[1] - 1
+        local try_find = end_line[1]:find "%S"
+        if try_find then
+            end_pos_find = try_find - 1
+        end
+        end_pos = vim.inspect_pos(bufnr, end_row, end_pos_find, {

	and #whitespace_tbl > current_indent_col_start_single
	and current_indent.start_row <= row
	and #whitespace_tbl > current_indent_col_start_single

feat: current indent #743

Are you sure you want to change the base?

feat: current indent #743

Conversation

lukas-reineke commented Oct 20, 2023

Danielkonge left a comment

Choose a reason for hiding this comment

Danielkonge commented Oct 20, 2023 • edited Loading

lukas-reineke commented Oct 20, 2023

Danielkonge commented Oct 20, 2023

Danielkonge Oct 20, 2023

Choose a reason for hiding this comment

Danielkonge Oct 20, 2023 • edited Loading

Choose a reason for hiding this comment

Danielkonge Oct 20, 2023 • edited Loading

Choose a reason for hiding this comment

Danielkonge commented Oct 20, 2023

Danielkonge Oct 20, 2023

Choose a reason for hiding this comment

Danielkonge Oct 20, 2023

Choose a reason for hiding this comment

Danielkonge commented Oct 21, 2023 • edited Loading

Danielkonge commented Oct 24, 2023 • edited Loading

Danielkonge left a comment • edited Loading

Choose a reason for hiding this comment

Danielkonge left a comment

Choose a reason for hiding this comment

Danielkonge Oct 27, 2023 • edited Loading

Choose a reason for hiding this comment

Danielkonge commented Nov 9, 2023 • edited Loading

mehalter commented Nov 9, 2023

Danielkonge commented Nov 9, 2023

mehalter commented Nov 9, 2023

Danielkonge left a comment

Choose a reason for hiding this comment

Danielkonge Nov 12, 2023

Choose a reason for hiding this comment

lukas-reineke commented Dec 6, 2023

mehalter commented Dec 6, 2023

This comment was marked as resolved.

lukas-reineke commented Dec 15, 2023

mehalter commented Sep 6, 2024

lukas-reineke commented Sep 7, 2024

jdelgadofrts commented Oct 16, 2024

Danielkonge commented Oct 20, 2023 •

edited

Loading

Danielkonge Oct 20, 2023 •

edited

Loading

Danielkonge Oct 20, 2023 •

edited

Loading

Danielkonge commented Oct 21, 2023 •

edited

Loading

Danielkonge commented Oct 24, 2023 •

edited

Loading

Danielkonge left a comment •

edited

Loading

Danielkonge Oct 27, 2023 •

edited

Loading

Danielkonge commented Nov 9, 2023 •

edited

Loading