feat(ui): virtual indent #561

danilshvalov · 2023-05-10T21:03:23Z

Preview

virtual-indent.mov

How to try it

Install neovim with feat(ui): inline virtual text (2) neovim/neovim#23426
Add the following code to your orgmode configuration:

local VirtualIndent = require("orgmode.ui.virtual-indent"):new()
VirtualIndent:attach()

TODO

Customizable indentation size (hidden or visible stars, possibly custom indentation)
Documentation

IllustratedMan-code · 2023-05-19T15:40:46Z

This looks great! Hopefully inline virtual text gets merged soon.

danilshvalov · 2023-05-22T14:47:24Z

It has happened! Virtual text is merged into the master branch! So I've made some changes, now you can enable virtual indent as follows:

require("orgmode").setup({
  org_indent_mode = "virtual_indent",
  ui = {
    virtual_indent = {
      handler = nil,
      --- or
      handler = function(buffer, start_line, end_line)
        -- ...
      end,
    },
  },
})

danilshvalov · 2023-05-22T19:28:35Z

Ready for review

kristijanhusak

Thanks for the PoC!

Generally looks ok, but I think we need to do some additional tweaking.
Check my comments.

kristijanhusak · 2023-05-28T16:10:27Z

lua/orgmode/config/defaults.lua

@@ -175,6 +175,9 @@ local DefaultConfig = {
    menu = {
      handler = nil,
    },
+    virtual_indent = {


Why would we need a custom handler for this?

For example, if the user wants to make virtual indents with indent lines (something like indent-blankline.nvim). Or change the size of the indentation. Or make the indentation colored depending on its size or title. It is quite difficult to cover all the options, so the user can provide his own handler.

Let's remove this option for the time being. Once the feature is officially released and there is a proper Neovim release with the support, we can expand on it.

kristijanhusak · 2023-05-28T16:17:25Z

lua/orgmode/org/indent.lua

@@ -194,8 +195,15 @@ local function foldtext()
  return line .. config.org_ellipsis
 end

+local function setup()
+  if config.org_indent_mode == 'virtual_indent' then


We need to check if value is noindent here.

Why? And if the user doesn't want any indentation? I see three options for using indentation:

No indentation

Virtual indentation

Real indentation

No indentation was initially meant to be used as virtual indentation.
If you check in the Emacs docs, there are two values, indent and noindent (https://orgmode.org/manual/Org-Indent-Mode.html)

Problem is that I set the indent as default, where it should actually be noindent. indent option is actually a virtual indent. I'll fix that and announce it on the breaking change issue so people are aware. Once I do that you will actually have to check for indent value.

Why not have 3 options? Yes, this is somewhat at odds with emacs, but it makes the configuration more flexible.

noindent option as it is now is not useful at all. Everything is aligned to the left. As far as I know, people are now using it only to get proper formatting with other tools, like Orgzly. What we have now by default will become noindent, and this PR will introduce a proper indent option. There's no need for 3rd.

I know it may be weird, but some people don't use indentation. Some time ago I came across this discussion and found out that not everyone needs indents (see the first comment).

In addition, if you break backward compatibility with indent, quite a lot of org files can be visually broken. I'm not sure if this is a good idea.

We can allow that functionality by doing the same thing that Emacs does, via org-adapt-indentation option. The discussion has a few comments explaining how it works.

kristijanhusak · 2023-05-28T16:19:13Z

lua/orgmode/ui/virtual-indent.lua

+
+  self:set_indent(buffer, 0, vim.api.nvim_buf_line_count(buffer) - 1)
+
+  vim.api.nvim_buf_attach(buffer, true, {


Why do we need vim.schedule in the callback?

Also, is there any advantage of using nvim_buf_attach over nvim_set_decoration_provider ?
We use decoration provider for markup, so we could maybe use the same for this while using the ephermal ?

We need vim.schedule, because otherwise, when undoing, the virtual indent handler is called too early and processed incorrectly.

As far as I know, ephemeral virtual text has not been implemented yet.

I gave it a quick test, and it seems to work. Switching to it should reduce some code that does the cleanup. Lets try switching to decoration provider and see if it works out.

Is it true? I get E5108: Error executing lua [string ":lua"]:1: not yet implemented error.

Here is the code I run:

vim.api.nvim_buf_set_extmark(0, vim.api.nvim_create_namespace("test"), 0, 1, {virt_text_pos = "inline", virt_text = {{" "}}, ephemeral = true})

My neovim version is NVIM v0.10.0-dev-410+gc48f94d1f

Okay, I get the point. I'll try to redo it

milanglacier · 2023-06-02T16:22:46Z

This is one of the most missing UI features of emacs in neovim! I am glad that finally, this is implemented!

kristijanhusak · 2024-01-25T20:54:44Z

Closing this since it was resolved in #627

PriceHiller · 2024-01-25T20:57:12Z

Thanks @danilshvalov for the initial work 😉

feat(ui): add virtual indent draft

8314f2f

danilshvalov mentioned this pull request May 10, 2023

Status of org-indent-mode functionality? #422

Open

danilshvalov changed the title ~~feat(ui): add virtual indent~~ feat(ui): virtual indent May 10, 2023

refactor: remove extra params

5673f8c

danilshvalov added 2 commits May 22, 2023 16:54

chore: merge master branch

0a45eca

feat: add virtual indent config

61d2cc8

fix: remove unwanted change

7a1bac3

danilshvalov marked this pull request as ready for review May 22, 2023 14:49

danilshvalov added 3 commits May 22, 2023 22:14

docs: add virtual indent

f3dfdff

docs: add more info

610c080

docs: replace margins to indents

e4fb3bb

kristijanhusak requested changes May 28, 2023

View reviewed changes

kristijanhusak force-pushed the master branch 2 times, most recently from 9094379 to abff0dc Compare November 6, 2023 20:52

PriceHiller mentioned this pull request Nov 9, 2023

Add Virtual Indent #627

Merged

kristijanhusak closed this Jan 25, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(ui): virtual indent #561

feat(ui): virtual indent #561

danilshvalov commented May 10, 2023 •

edited

Loading

IllustratedMan-code commented May 19, 2023

danilshvalov commented May 22, 2023

danilshvalov commented May 22, 2023

kristijanhusak left a comment

kristijanhusak May 28, 2023

danilshvalov May 28, 2023

kristijanhusak May 28, 2023

kristijanhusak May 28, 2023

danilshvalov May 28, 2023

kristijanhusak May 28, 2023

danilshvalov May 28, 2023

kristijanhusak May 28, 2023

danilshvalov May 28, 2023

kristijanhusak May 28, 2023

kristijanhusak May 28, 2023

danilshvalov May 28, 2023

kristijanhusak May 28, 2023

danilshvalov May 28, 2023

danilshvalov May 28, 2023

milanglacier commented Jun 2, 2023

kristijanhusak commented Jan 25, 2024

PriceHiller commented Jan 25, 2024


		self:set_indent(buffer, 0, vim.api.nvim_buf_line_count(buffer) - 1)

		vim.api.nvim_buf_attach(buffer, true, {

feat(ui): virtual indent #561

feat(ui): virtual indent #561

Conversation

danilshvalov commented May 10, 2023 • edited Loading

Preview

How to try it

TODO

IllustratedMan-code commented May 19, 2023

danilshvalov commented May 22, 2023

danilshvalov commented May 22, 2023

kristijanhusak left a 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

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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

milanglacier commented Jun 2, 2023

kristijanhusak commented Jan 25, 2024

PriceHiller commented Jan 25, 2024

danilshvalov commented May 10, 2023 •

edited

Loading