Merge pull request #43 from savchenko/main

Improve level detection, allow disabling in specific TreeSitter classes, add toggle functionality and lazy-loading

Author: glepnir

README.md

@@ -1,40 +1,96 @@
 # indentmini.nvim
 
-An indentation plugin born for the pursuit of **minimal**(~120 lines), **speed**(blazing fastest on files with tens of thousands of lines) and **stability**.
-It renders in the neovim screen redraw circle and will never make your neovim slow.
-
-![indentmini](https://github.com/nvimdev/indentmini.nvim/assets/41671631/99fb6dd4-8e61-412f-aa4c-c83ee7ce3206)
+An indentation plugin born for the pursuit of minimalism, speed and stability.<br>
+It renders in the NeoVim screen redraw circle and should keep the NeoVim fast.
 
 ## Install
 
-install with any plugin management or default vim package.
+Install with any plugin manager or as a NeoVim package.
+
+## Configuration
 
-## Config
+| Key              | Description                                   | Default                   |
+|------------------|-----------------------------------------------|---------------------------|
+| char             | Character to draw the indentation guides      | `<BAR>`                   |
+| enabled          | Default state of the plugin                   | `true`                    |
+| exclude          | Disable in these filetypes                    | `{}`                      |
+| exclude_nodetype | TreeSitter classes where guides are not drawn | `{ 'string', 'comment' }` |
+| key              | Hotkey to toggle the guides                   | `''`                      |
+| minlevel         | Minimum level where indentation is drawn      | `0`                       |
+| only_current     | only highlight current indentation level      | `false`                   |
 
-available config values in setup table.
+### Example
 
-- char     -- string type default is `│`,
-- exclude  -- table  type add exclude filetype in this table ie `{ 'markdown', 'xxx'}`
-- minlevel -- number the min level that show indent line default is 1
-- only_current -- boolean default is false when true will only highlight current range
+The plugin supports lazy-loading:
 
 ```lua
-config = function()
-    require("indentmini").setup() -- use default config
-end,
+-- Either declare `vim.g.indentmini_key` before you load the plugin:
+vim.g.indentmini_key = '<F5>'
+
+-- or use your plugin manager, for example Lazy.nvim:
+{
+    url = 'https://github.com/nvimdev/indentmini.nvim',
+    cmd = { 'IndentToggle', 'IndentEnable', 'IndentDisable' },
+    keys = {
+        {'<F5>', '<Cmd>IndentToggle<CR>', desc = 'Toggle indent guides'},
+    },
+    lazy = true,
+    config = function()
+        require("indentmini").setup({
+            only_current = false,
+            enabled = false,
+            char = '▏',
+            key = '<F5>', -- optional, can be set here if you don't lazy-load
+            minlevel = 2,
+            exclude = { 'markdown', 'help', 'text', 'rst' },
+            exclude_nodetype = { 'string', 'comment' }
+        })
+    end
+}
 ```
 
-## Highlight
+## Toggle functionality
+
+You can toggle the guides via:
+
+#### Commands
 
-if your colorscheme not config the `IndentLine*` relate highlight group you should config it in
-your neovim config.
+- `:IndentToggle` - Toggle indent guides on/off
+- `:IndentEnable` - Enable indent guides
+- `:IndentDisable` - Disable indent guides
+
+#### Hotkey
+
+For lazy-loading setups, set the global variable before the plugin loads:
+```lua
+vim.g.indentmini_key = '<F5>'
+```
+
+For non-lazy setups, use the `key` option in `setup()`:
+```lua
+require("indentmini").setup({
+    key = '<F5>',
+})
+```
+
+#### API
+
+```lua
+local indentmini = require("indentmini")
+indentmini.toggle()
+indentmini.enable()
+indentmini.disable()
+```
+
+## Colours
+
+The plugin uses `IndentLine*` highlight groups and provides no default values.
 
 ```lua
--- Colors are applied automatically based on user-defined highlight groups.
--- There is no default value.
 vim.cmd.highlight('IndentLine guifg=#123456')
--- Current indent line highlight
 vim.cmd.highlight('IndentLineCurrent guifg=#123456')
 ```
 
-## License MIT
+## Licence
+
+MIT

lua/indentmini/init.lua

@@ -5,13 +5,16 @@ local ffi, treesitter = require('ffi'), vim.treesitter
 local opt = {
   only_current = false,
   exclude = { 'dashboard', 'lazy', 'help', 'nofile', 'terminal', 'prompt', 'qf' },
+  exclude_nodetype = { 'string', 'comment' },
   config = {
     virt_text_pos = 'overlay',
     hl_mode = 'combine',
     ephemeral = true,
   },
 }
 
+local enabled = true
+
 ffi.cdef([[
   typedef struct {} Error;
   typedef int colnr_T;
@@ -229,6 +232,15 @@ local function on_line(_, _, bufnr, row)
     if context.is_tab and not context.mixup then
       col = level - 1
     end
+    if context.has_ts then
+      local node = treesitter.get_node({ bufnr = bufnr, pos = { row, col }, ignore_injections = true })
+      while node do
+        if vim.tbl_contains(opt.exclude_nodetype, node:type()) then
+          goto continue
+        end
+        node = node:parent()
+      end
+    end
     if
       col >= context.leftcol
       and level >= opt.minlevel
@@ -248,10 +260,14 @@ local function on_line(_, _, bufnr, row)
       buf_set_extmark(bufnr, ns, row, col, opt.config)
       opt.config.virt_text_win_col = nil
     end
+    ::continue::
   end
 end
 
 local function on_win(_, winid, bufnr, toprow, botrow)
+  if not enabled then
+    return false
+  end
   if
     bufnr ~= api.nvim_get_current_buf()
     or vim.iter(opt.exclude):find(function(v)
@@ -279,16 +295,67 @@ local function on_win(_, winid, bufnr, toprow, botrow)
   local pos = api.nvim_win_get_cursor(winid)
   context.currow = pos[1] - 1
   context.curcol = pos[2]
-  find_current_range(find_in_snapshot(context.currow + 1).indent, context.currow)
+  local cur_indent = find_in_snapshot(context.currow + 1).indent
+  local next_indent = (context.currow + 1 < context.count) and find_in_snapshot(context.currow + 2).indent or 0
+  -- We only want to look backwards if we are closing a block
+  local line_text = api.nvim_get_current_line()
+  local is_closer = line_text:find('^%s*[})%]]') or line_text:find('^%s*end')
+  local target_indent = cur_indent
+  if next_indent > cur_indent then
+    target_indent = next_indent
+  elseif is_closer then
+    local prev_indent = context.currow > 0 and find_in_snapshot(context.currow).indent or 0
+    if prev_indent > cur_indent then
+      target_indent = prev_indent
+    end
+  end
+  find_current_range(target_indent, context.currow)
 end
 
-return {
-  setup = function(conf)
-    conf = conf or {}
-    opt.only_current = conf.only_current or false
-    opt.exclude = vim.list_extend(opt.exclude, conf.exclude or {})
-    opt.config.virt_text = { { conf.char or '│' } }
-    opt.minlevel = conf.minlevel or 1
-    set_provider(ns, { on_win = on_win, on_line = on_line })
-  end,
-}
+local M = {}
+
+function M.toggle()
+  enabled = not enabled
+  vim.api.nvim__redraw({
+      buf = vim.api.nvim_get_current_buf(),
+      valid = false
+  })
+end
+
+function M.enable()
+  enabled = true
+  vim.api.nvim__redraw({
+      buf = vim.api.nvim_get_current_buf(),
+      valid = false
+  })
+end
+
+function M.disable()
+  enabled = false
+  vim.api.nvim__redraw({
+      buf = vim.api.nvim_get_current_buf(),
+      valid = false
+  })
+end
+
+--- @param conf table|nil IndentMini config
+function M.setup(conf)
+  conf = conf or {}
+  enabled = conf.enabled ~= false
+  opt.only_current = conf.only_current or false
+  opt.exclude = vim.list_extend(opt.exclude, conf.exclude or {})
+  opt.exclude_nodetype = vim.list_extend(opt.exclude_nodetype, conf.exclude_nodetype or {})
+  opt.config.virt_text = { { conf.char or '│' } }
+  opt.minlevel = conf.minlevel or 1
+  set_provider(ns, { on_win = on_win, on_line = on_line })
+
+  if conf.key then
+    vim.keymap.set('n', conf.key, '<Cmd>IndentToggle<CR>', {
+      desc = 'Toggle indent guides',
+      noremap = true,
+      silent = true,
+    })
+  end
+end
+
+return M

plugin/indentmini.lua

@@ -0,0 +1,25 @@
+vim.api.nvim_create_user_command(
+    'IndentToggle',
+    function() require('indentmini').toggle() end,
+    { desc = 'Toggle indent guides' }
+)
+
+vim.api.nvim_create_user_command(
+    'IndentEnable',
+    function() require('indentmini').enable() end,
+    { desc = 'Enable indent guides' }
+)
+
+vim.api.nvim_create_user_command(
+    'IndentDisable',
+    function() require('indentmini').disable() end,
+    { desc = 'Disable indent guides' }
+)
+
+if vim.g.indentmini_key then
+    vim.keymap.set('n', vim.g.indentmini_key, '<Cmd>IndentToggle<CR>', {
+        desc = 'Toggle indent guides',
+        noremap = true,
+        silent = true,
+    })
+end