feat: support for orgmode style cycling

[neo451]

@sotte

Adpated from nvim-orgmode, works pretty well for me, try it out!

I also made the smart action use this. In order to do that I realized I could use <Plug> mappings, which leads me to think we have a bit of a too verbose command system, stuff like paste_img, extract_note is not really that great to use as a user command, I am not talking about deleting them, but I think we should provide more <Plug> mappings, and new feature that is not worth to be a command can go in this direction as well.

[sotte]

@neo451, wow, that was quick.

I just gave it a a test run. First of all: much better than the default folding behavior. I missed it :)

I think I could create a few edge cases / inconsistent behavior.

When the cursor is on a checklist, cycle just toggles the fold for the the list:

Here it toggles the list, fine.

But when I'm on a listitem a bit further down, it toggles the entire heading.

shift-tab does not work for me at all. but let me check my terminal and nvim setup to make sure that it's not a problem on my side. The behavior is fishy.

More testing by anybody is highly welcome.

[sotte]

Oh, and as always, we should add docs :)

Side note: yes, plugs are handy. I also think that our user commands are a bit to unwieldy. Not because they are not plugs, but because they contain a lot of logic. I with more of the logic was just a lua function that I could easily use to script custom things. But sometimes useful functionality is hidden within the user command and you cannot use it as only the function for the command itself is exposed.

Just to get an idea about the complexity of the commands:

❯ wc -l lua/obsidian/commands/*.lua
  136 lua/obsidian/commands/backlinks.lua
   51 lua/obsidian/commands/check.lua
   76 lua/obsidian/commands/dailies.lua
  148 lua/obsidian/commands/debug.lua
   43 lua/obsidian/commands/extract_note.lua
   10 lua/obsidian/commands/follow_link.lua
  194 lua/obsidian/commands/init-legacy.lua
  250 lua/obsidian/commands/init.lua
   40 lua/obsidian/commands/link.lua
   32 lua/obsidian/commands/link_new.lua
   88 lua/obsidian/commands/links.lua
   25 lua/obsidian/commands/new.lua
   41 lua/obsidian/commands/new_from_template.lua
  108 lua/obsidian/commands/open.lua
   29 lua/obsidian/commands/paste_img.lua
   19 lua/obsidian/commands/quick_switch.lua
  312 lua/obsidian/commands/rename.lua
   12 lua/obsidian/commands/search.lua
   96 lua/obsidian/commands/tags.lua
   37 lua/obsidian/commands/template.lua
   26 lua/obsidian/commands/toc.lua
   20 lua/obsidian/commands/today.lua
   22 lua/obsidian/commands/toggle_checkbox.lua
    6 lua/obsidian/commands/tomorrow.lua
   34 lua/obsidian/commands/workspace.lua
    6 lua/obsidian/commands/yesterday.lua
 1861 total

[sotte]

shift+tab is due to some kitty settings on my end. will fix it tomorrow and give feedback.

Edit: fixed it. global cycle works like a charm!

[sotte]

I just checked nvim-orgmode and the implemented behavior is different that what I get in this PR. The orgmode implementation does not toggle lists.
I'm not sure if we want to follow it one to one.

I wonder if we can specify tests for this. Do screen tests work for this?! :)

[sotte]

I've been using this branch for the last little while and I don't want to miss it anymore. Especially for bigger files, this is very useful.

@neo451 why don't we merge this and improve it as we go along?

[neo451]

Ah yes, I forgot about this. I think I can pick this up again, trying to address the little points you mentioned a couple of times back then and I found I don't have a good mental grasp of how the folding thing worked, I can give it a try again, but like you mentioned we can merge the current one anyway.