Merge pull request #154 from NotAShelf/feat/bump-ibl

modules/visuals: update indent-blankline to v3
NotAShelf · Nov 24, 2023 · 712b8a8 · 712b8a8
2 parents a535f87 + 663a612
commit 712b8a8
Show file tree

Hide file tree

Showing 5 changed files with 77 additions and 35 deletions.
diff --git a/configuration.nix b/configuration.nix
@@ -89,7 +89,9 @@ inputs: let
           enable = true;
           fillChar = null;
           eolChar = null;
-          showCurrContext = true;
+          scope = {
+            enabled = true;
+          };
         };
 
         cursorline = {

diff --git a/docs/release-notes/rl-0.5.adoc b/docs/release-notes/rl-0.5.adoc
@@ -78,6 +78,8 @@ https://github.com/notashelf[notashelf]:
 To quote home-manager commit: "Output is mostly unchanged aside from some minor typographical and
 formatting changes, along with better source links."
 
+* Updated indent-blankine.nvim to v3 - this comes with a few option changes, which will be migrated with `renamedOptionModule`
+
 
 https://github.com/jacekpoz[jacekpoz]:
 

diff --git a/flake.lock b/flake.lock
diff --git a/modules/visuals/config.nix b/modules/visuals/config.nix
@@ -12,7 +12,7 @@ in {
       vim.startPlugins = ["indent-blankline"];
       vim.luaConfigRC.indent-blankline = nvim.dag.entryAnywhere ''
         -- highlight error: https://github.com/lukas-reineke/indent-blankline.nvim/issues/59
-        vim.wo.colorcolumn = "99999"
+        -- vim.wo.colorcolumn = "99999"
         vim.opt.list = true
 
         ${optionalString (cfg.indentBlankline.eolChar != null) ''
@@ -22,12 +22,20 @@ in {
           vim.opt.listchars:append({ space = "${cfg.indentBlankline.fillChar}" })
         ''}
 
-        require("indent_blankline").setup {
+        require("ibl").setup {
           enabled = true,
-          char = "${cfg.indentBlankline.listChar}",
-          show_current_context = ${boolToString cfg.indentBlankline.showCurrContext},
-          show_end_of_line = ${boolToString cfg.indentBlankline.showEndOfLine},
-          use_treesitter = ${boolToString cfg.indentBlankline.useTreesitter},
+          debounce = ${toString cfg.indentBlankline.debounce},
+          indent = { char = "${cfg.indentBlankline.indent.char}" },
+
+          viewport_buffer = {
+            min = ${toString cfg.indentBlankline.viewportBuffer.min},
+            max = ${toString cfg.indentBlankline.viewportBuffer.max},
+          },
+
+          scope = {
+            enabled = ${boolToString cfg.indentBlankline.scope.enabled},
+            show_end = ${boolToString cfg.indentBlankline.scope.showEndOfLine}
+          },
         }
       '';
     })

diff --git a/modules/visuals/visuals.nix b/modules/visuals/visuals.nix
@@ -3,10 +3,16 @@
   lib,
   ...
 }: let
-  inherit (lib) mkEnableOption mkMappingOption mkOption types literalExpression;
+  inherit (lib) mkEnableOption mkMappingOption mkOption types literalExpression mkRenamedOptionModule mkRemovedOptionModule;
 
   cfg = config.vim.visuals;
 in {
+  imports = [
+    (mkRenamedOptionModule ["vim" "visuals" "indentBlankline" "showCurrContext"] ["vim" "visuals" "indentBlankline" "scope" "enabled"])
+    (mkRenamedOptionModule ["vim" "visuals" "indentBlankline" "showEndOfLine"] ["vim" "visuals" "indentBlankline" "scope" "showEndOfLine"])
+    (mkRemovedOptionModule ["vim" "visuals" "indentBlankline" "useTreesitter"] "`vim.visuals.indentBlankline.useTreesitter` has been removed upstream and can safely be removed from your configuration.")
+  ];
+
   options.vim.visuals = {
     enable = mkEnableOption "Visual enhancements.";
 
@@ -60,6 +66,35 @@ in {
 
     indentBlankline = {
       enable = mkEnableOption "indentation guides [indent-blankline]";
+      debounce = mkOption {
+        type = types.int;
+        description = "Debounce time in milliseconds";
+        default = 200;
+      };
+
+      viewportBuffer = {
+        min = mkOption {
+          type = types.int;
+          description = "Number of lines above and below of what is currently
+            visible in the window";
+          default = 30;
+        };
+
+        max = mkOption {
+          type = types.int;
+          description = "Number of lines above and below of what is currently
+            visible in the window";
+          default = 500;
+        };
+      };
+
+      indent = {
+        char = mkOption {
+          type = types.str;
+          description = "Character for indentation line";
+          default = "│";
+        };
+      };
 
       listChar = mkOption {
         type = types.str;
@@ -79,28 +114,23 @@ in {
         default = "↴";
       };
 
-      showEndOfLine = mkOption {
-        description = ''
-          Displays the end of line character set by [](#opt-vim.visuals.indentBlankline.eolChar) instead of the
-          indent guide on line returns.
-        '';
-        type = types.bool;
-        default = cfg.indentBlankline.eolChar != null;
-        defaultText = literalExpression "config.vim.visuals.indentBlankline.eolChar != null";
-      };
-
-      showCurrContext = mkOption {
-        description = "Highlight current context from treesitter";
-        type = types.bool;
-        default = config.vim.treesitter.enable;
-        defaultText = literalExpression "config.vim.treesitter.enable";
-      };
+      scope = {
+        enabled = mkOption {
+          description = "Highlight current scope from treesitter";
+          type = types.bool;
+          default = config.vim.treesitter.enable;
+          defaultText = literalExpression "config.vim.treesitter.enable";
+        };
 
-      useTreesitter = mkOption {
-        description = "Use treesitter to calculate indentation when possible.";
-        type = types.bool;
-        default = config.vim.treesitter.enable;
-        defaultText = literalExpression "config.vim.treesitter.enable";
+        showEndOfLine = mkOption {
+          description = ''
+            Displays the end of line character set by [](#opt-vim.visuals.indentBlankline.eolChar) instead of the
+            indent guide on line returns.
+          '';
+          type = types.bool;
+          default = cfg.indentBlankline.eolChar != null;
+          defaultText = literalExpression "config.vim.visuals.indentBlankline.eolChar != null";
+        };
       };
     };