Merge 95705bc43b into de20ff2c51

Co-authored-by: raf <raf@notashelf.dev>

docs/release-notes/rl-0.5.md

@@ -83,7 +83,7 @@ Release notes for release 0.5
 
 - Updated indent-blankine.nvim to v3 - this comes with a few option changes, which will be migrated with `renamedOptionModule`
 
-[jacekpoz](https://github.com/jacekpoz):
+[jacekpoz](https://jacekpoz.pl):
 
 - Fixed scrollOffset not being used
 

docs/release-notes/rl-0.6.md

@@ -62,7 +62,7 @@ vim.api.nvim_set_keymap('n', '<leader>a', ':lua camelToSnake()<CR>', { noremap =
 
 - Added rose-pine theme.
 
-[jacekpoz](https://github.com/jacekpoz):
+[jacekpoz](https://jacekpoz.pl):
 
 - Added `vim.autocomplete.alwaysComplete`. Allows users to have the autocomplete window popup only when manually activated.
 

docs/release-notes/rl-0.7.md

@@ -53,6 +53,7 @@ configuration formats.
   longer filtered and thus should be used instead.
 - Add dap-go for better dap configurations
 - Make noice.nvim customizable
+- Standardize border style options and add custom borders
 
 [rust-tools.nvim]: https://github.com/simrat39/rust-tools.nvim
 [rustaceanvim]: https://github.com/mrcjkb/rustaceanvim
@@ -62,14 +63,17 @@ configuration formats.
   recommended to go through rustacean.nvim's README to take a closer look at its
   features and usage
 
-[jacekpoz](https://github.com/jacekpoz):
+[jacekpoz](https://jacekpoz.pl):
 
 [ocaml-lsp]: https://github.com/ocaml/ocaml-lsp
+[new-file-template.nvim]: https://github.com/otavioschwanck/new-file-template.nvim
 
 - Add [ocaml-lsp] support
 
 - Fix "Emac" typo
 
+- Add [new-file-template.nvim] to automatically fill new file contents using templates.
+
 [diniamo](https://github.com/diniamo):
 
 - Move the `theme` dag entry to before `luaScript`.
@@ -140,10 +144,10 @@ configuration formats.
 - Add [neo-tree.nvim] as an alternative file-tree plugin. It will be available
   under `vim.filetree.neo-tree`, similar to nvimtree.
 
-- Add `print-nvf-config` & `print-nvf-config-path` helper scripts to Neovim
+- Add `nvf-print-config` & `nvf-print-config-path` helper scripts to Neovim
   closure. Both of those scripts have been automatically added to your PATH upon
   using neovimConfig or `programs.nvf.enable`.
-  - `print-nvf-config` will display your `init.lua`, in full.
+  - `nvf-print-config` will display your `init.lua`, in full.
-  - `print-nvf-config-path` will display the path to _a clone_ of your
+  - `nvf-print-config-path` will display the path to _a clone_ of your
     `init.lua`. This is not the path used by the Neovim wrapper, but an
     identical clone.

flake.nix

@@ -628,9 +628,15 @@
     };
 
     plugin-nvim-nio = {
-      # (required nvim-dap-ui)
+      # (required by nvim-dap-ui)
       url = "github:nvim-neotest/nvim-nio";
       flake = false;
     };
+
+    plugin-new-file-template-nvim = {
+      # (required by new-file-template.nvim)
+      url = "github:otavioschwanck/new-file-template.nvim";
+      flake = false;
+    };
   };
 }

lib/types/default.nix

@@ -9,7 +9,7 @@
   typesCustom = import ./custom.nix {inherit lib;};
 in {
   inherit (typesDag) dagOf;
-  inherit (typesPlugin) pluginsOpt extraPluginType mkPluginSetupOption luaInline pluginType;
+  inherit (typesPlugin) pluginsOpt extraPluginType mkPluginSetupOption luaInline pluginType borderType;
   inherit (typesLanguage) diagnostics mkGrammarOption;
   inherit (typesCustom) anythingConcatLists char;
 }

lib/types/plugins.nix

@@ -51,9 +51,13 @@
       };
     };
   };
+
+  borderPresets = ["none" "single" "double" "rounded" "solid" "shadow"];
 in {
   inherit extraPluginType fromInputs pluginType;
 
+  borderType = either (enum borderPresets) (listOf (either str (listOf str)));
+
   pluginsOpt = {
     description,
     example,

modules/default.nix

@@ -7,11 +7,9 @@ inputs: {
   extraModules ? [],
 }: let
   inherit (pkgs) vimPlugins;
-  inherit (pkgs.vimUtils) buildVimPlugin;
   inherit (lib.strings) isString toString;
   inherit (lib.lists) filter map concatLists;
-  inherit (lib.attrsets) recursiveUpdate getAttr;
+  inherit (lib.attrsets) recursiveUpdate;
-  inherit (lib.asserts) assertMsg;
 
   # import modules.nix with `check`, `pkgs` and `lib` as arguments
   # check can be disabled while calling this file is called
@@ -33,12 +31,21 @@ inputs: {
   # build a vim plugin with the given name and arguments
   # if the plugin is nvim-treesitter, warn the user to use buildTreesitterPlug
   # instead
-  buildPlug = {pname, ...} @ attrs: let
+  buildPlug = attrs: let
-    src = getAttr ("plugin-" + pname) inputs;
+    src = inputs."plugin-${attrs.pname}";
   in
     pkgs.stdenvNoCC.mkDerivation ({
-        inherit src;
         version = src.shortRev or src.shortDirtyRev or "dirty";
+
+        inherit src;
+
+        nativeBuildInputs = with pkgs.vimUtils; [
+          vimCommandCheckHook
+          vimGenDocHook
+          neovimRequireCheckHook
+        ];
+        passthru.vimPlugin = true;
+
         installPhase = ''
           runHook preInstall
 
@@ -50,41 +57,27 @@ inputs: {
       }
       // attrs);
 
-  noBuildPlug = {pname, ...} @ attrs: let
-    input = getAttr ("plugin-" + pname) inputs;
-  in
-    {
-      version = input.shortRev or input.shortDirtyRev or "dirty";
-      outPath = getAttr ("plugin-" + pname) inputs;
-    }
-    // attrs;
-
   buildTreesitterPlug = grammars: vimPlugins.nvim-treesitter.withPlugins (_: grammars);
 
+  pluginBuilders = {
+    nvim-treesitter = buildTreesitterPlug vimOptions.treesitter.grammars;
+    flutter-tools-patched =
+      buildPlug
+      {
+        pname = "flutter-tools";
+        patches = [../patches/flutter-tools.patch];
+      };
+  };
+
   buildConfigPlugins = plugins:
     map
-    (plug: (
+    (
-      if (isString plug)
+      plug:
-      then
+        if (isString plug)
-        (
+        then pluginBuilders.${plug} or (buildPlug {pname = plug;})
-          if (plug == "nvim-treesitter")
+        else plug
-          then (buildTreesitterPlug vimOptions.treesitter.grammars)
+    )
-          else if (plug == "flutter-tools-patched")
+    (filter (f: f != null) plugins);
-          then
-            (
-              buildPlug
-              {
-                pname = "flutter-tools";
-                patches = [../patches/flutter-tools.patch];
-              }
-            )
-          else noBuildPlug {pname = plug;}
-        )
-      else plug
-    ))
-    (filter
-      (f: f != null)
-      plugins);
 
   # built (or "normalized") plugins that are modified
   builtStartPlugins = buildConfigPlugins vimOptions.startPlugins;
@@ -114,20 +107,11 @@ inputs: {
     inherit extraLuaPackages extraPython3Packages;
   };
 
+  dummyInit = pkgs.writeText "nvf-init.lua" vimOptions.builtLuaConfigRC;
   # Additional helper scripts for printing and displaying nvf configuration
   # in your commandline.
-  printConfig = pkgs.writers.writeDashBin "print-nvf-config" ''
+  printConfig = pkgs.writers.writeDashBin "nvf-print-config" "cat ${dummyInit}";
-    cat << EOF
+  printConfigPath = pkgs.writers.writeDashBin "nvf-print-config-path" "echo -n ${dummyInit}";
-      ${vimOptions.builtLuaConfigRC}
-    EOF
-  '';
-
-  printConfigPath = pkgs.writers.writeDashBin "print-nvf-config-path" ''
-    realpath ${pkgs.writeTextFile {
-      name = "nvf-init.lua";
-      text = vimOptions.builtLuaConfigRC;
-    }}
-  '';
 in {
   inherit (module) options config;
   inherit (module._module.args) pkgs;
@@ -137,7 +121,7 @@ in {
   neovim = pkgs.symlinkJoin {
     name = "nvf-with-helpers";
     paths = [neovim-wrapped printConfig printConfigPath];
-    postBuild = "echo helpers added";
+    postBuild = "echo Helpers added";
 
     meta = {
       description = "Wrapped version of Neovim with additional helper scripts";

modules/plugins/lsp/lspconfig/config.nix

@@ -7,6 +7,7 @@
   inherit (lib.strings) optionalString;
   inherit (lib.attrsets) mapAttrs;
   inherit (lib.nvim.dag) entryAfter;
+  inherit (lib.nvim.lua) toLuaObject;
 
   cfg = config.vim.lsp;
 in {
@@ -22,7 +23,7 @@ in {
 
           ${
             optionalString config.vim.ui.borders.enable ''
-              require('lspconfig.ui.windows').default_options.border = '${config.vim.ui.borders.globalStyle}'
+              require('lspconfig.ui.windows').default_options.border = ${toLuaObject config.vim.ui.borders.globalStyle}
             ''
           }
         '';

modules/plugins/lsp/nvim-code-action-menu/config.nix

@@ -6,6 +6,7 @@
   inherit (lib.modules) mkIf;
   inherit (lib.nvim.dag) entryAnywhere;
   inherit (lib.nvim.binds) mkSetBinding addDescriptionsToMappings pushDownDefault;
+  inherit (lib.nvim.lua) toLuaObject;
 
   cfg = config.vim.lsp;
 
@@ -25,7 +26,7 @@ in {
 
       pluginRC.code-action-menu = entryAnywhere ''
         -- border configuration
-        vim.g.code_action_menu_window_border = '${config.vim.ui.borders.plugins.code-action-menu.style}'
+        vim.g.code_action_menu_window_border = ${toLuaObject config.vim.ui.borders.plugins.code-action-menu.style}
 
         -- show individual sections of the code action menu
         ${lib.optionalString cfg.nvimCodeActionMenu.show.details "vim.g.code_action_menu_show_details = true"}

modules/plugins/ui/borders/borders.nix

@@ -4,31 +4,34 @@
   ...
 }: let
   inherit (lib.options) mkOption mkEnableOption;
-  inherit (lib.lists) optionals;
+  inherit (lib.nvim.types) borderType;
-  inherit (lib.types) enum;
 
   cfg = config.vim.ui.borders;
-
-  defaultStyles = ["none" "single" "double" "rounded"];
 in {
   options.vim.ui.borders = {
     enable = mkEnableOption "visible borders for most windows";
 
     globalStyle = mkOption {
-      type = enum defaultStyles;
+      type = borderType;
       default = "rounded";
       description = ''
         The global border style to use.
+
+        If a list is given, it should have a length of eight or any divisor of
+        eight. The array will specify the eight chars building up the border in
+        a clockwise fashion starting with the top-left corner. You can specify
+        a different highlight group for each character by passing a
+        [char, "YourHighlightGroup"] instead
       '';
+      example = ["╔" "═" "╗" "║" "╝" "═" "╚" "║"];
     };
 
-    # TODO: make per-plugin borders configurable
     plugins = let
       mkPluginStyleOption = name: {
         enable = mkEnableOption "borders for the ${name} plugin" // {default = cfg.enable;};
 
         style = mkOption {
-          type = enum (defaultStyles ++ optionals (name != "which-key") ["shadow"]);
+          type = borderType;
           default = cfg.globalStyle;
           description = "The border style to use for the ${name} plugin";
         };

modules/plugins/ui/breadcrumbs/breadcrumbs.nix

@@ -4,9 +4,9 @@
   ...
 }: let
   inherit (lib.options) mkOption mkEnableOption;
-  inherit (lib.types) nullOr listOf enum bool str int;
+  inherit (lib.types) nullOr listOf enum bool str int either;
   inherit (lib.modules) mkRenamedOptionModule;
-  inherit (lib.nvim.types) mkPluginSetupOption;
+  inherit (lib.nvim.types) mkPluginSetupOption borderType;
   mkSimpleIconOption = default:
     mkOption {
       inherit default;
@@ -212,8 +212,7 @@ in {
           # position = {}
 
           border = mkOption {
-            # TODO: let this type accept a custom string
+            type = borderType;
-            type = enum ["single" "rounded" "double" "solid" "none"];
             default = config.vim.ui.borders.globalStyle;
             description = "border style to use";
           };
@@ -236,8 +235,7 @@ in {
               */
 
               border = mkOption {
-                # TODO: let this type accept a custom string
+                type = borderType;
-                type = nullOr (enum ["single" "rounded" "double" "solid" "none"]);
                 default = config.vim.ui.borders.globalStyle;
                 description = "border style to use for the left section of Navbuddy UI";
               };
@@ -254,8 +252,7 @@ in {
               */
 
               border = mkOption {
-                # TODO: let this type accept a custom string
+                type = borderType;
-                type = nullOr (enum ["single" "rounded" "double" "solid" "none"]);
                 default = config.vim.ui.borders.globalStyle;
                 description = "border style to use for the middle section of Navbuddy UI";
               };
@@ -265,8 +262,7 @@ in {
             # there is no size option for the right section, it fills the remaining space
             right = {
               border = mkOption {
-                # TODO: let this type accept a custom string
+                type = borderType;
-                type = nullOr (enum ["single" "rounded" "double" "solid" "none"]);
                 default = config.vim.ui.borders.globalStyle;
                 description = "border style to use for the right section of Navbuddy UI";
               };

modules/plugins/utility/binds/which-key/config.nix

@@ -25,7 +25,7 @@ in {
 
         ${optionalString config.vim.ui.borders.plugins.which-key.enable ''
         window = {
-          border = "${config.vim.ui.borders.plugins.which-key.style}",
+          border = ${toLuaObject config.vim.ui.borders.plugins.which-key.style},
         },
       ''}
       })

modules/plugins/utility/default.nix

@@ -4,6 +4,7 @@
     ./ccc
     ./gestures
     ./motion
+    ./new-file-template
     ./telescope
     ./icon-picker
     ./images

modules/plugins/utility/new-file-template/config.nix

@@ -0,0 +1,23 @@
+{
+  config,
+  lib,
+  ...
+}: let
+  inherit (lib.modules) mkIf;
+  inherit (lib.nvim.dag) entryAnywhere;
+  inherit (lib.nvim.lua) toLuaObject;
+
+  cfg = config.vim.utility.new-file-template;
+in {
+  config = mkIf cfg.enable {
+    vim = {
+      startPlugins = [
+        "new-file-template-nvim"
+      ];
+
+      pluginRC.new-file-template = entryAnywhere ''
+        require('new-file-template').setup(${toLuaObject cfg.setupOpts})
+      '';
+    };
+  };
+}

modules/plugins/utility/new-file-template/default.nix

@@ -0,0 +1,6 @@
+{
+  imports = [
+    ./config.nix
+    ./new-file-template.nix
+  ];
+}

modules/plugins/utility/new-file-template/new-file-template.nix

@@ -0,0 +1,54 @@
+{lib, ...}: let
+  inherit (lib.options) mkOption;
+  inherit (lib.types) attrsOf bool listOf str;
+  inherit (lib.nvim.types) mkPluginSetupOption;
+in {
+  options.vim.utility.new-file-template = {
+    enable = mkOption {
+      type = bool;
+      default = false;
+      description = ''
+        new-file-template.nvim: Automatically insert a template on new files in neovim.
+        ::: {.note}
+        For custom templates add a directory containing `lua/templates/*.lua`
+        to `vim.additionalRuntimePaths`.
+        :::
+        [custom-template-docs]: https://github.com/otavioschwanck/new-file-template.nvim?tab=readme-ov-file#creating-new-templates
+        More documentation on the templates available at [custom-template-docs]
+      '';
+    };
+
+    setupOpts = mkPluginSetupOption "nvim-file-template.nvim" {
+      disableInsert = mkOption {
+        type = bool;
+        default = false;
+        description = "Enter insert mode after inserting the template";
+      };
+
+      disableAutocmd = mkOption {
+        type = bool;
+        default = false;
+        description = "Disable the autocmd that creates the template";
+      };
+
+      disableFiletype = mkOption {
+        type = listOf str;
+        default = [];
+        description = "Disable default templates for specific filetypes";
+      };
+
+      disableSpecific = mkOption {
+        type = attrsOf (listOf str);
+        default = {};
+        description = "Disable specific regexp for the default templates.";
+        example = "{ ruby = [\".*\"]; }";
+      };
+
+      suffixAsFiletype = mkOption {
+        type = bool;
+        default = false;
+        description = "Use suffix of filename rather than `vim.bo.filetype` as filetype";
+      };
+    };
+  };
+}

modules/plugins/visuals/fidget/fidget.nix

@@ -7,7 +7,7 @@
   inherit (lib.options) mkEnableOption mkOption literalExpression;
   inherit (lib.strings) toUpper;
   inherit (lib.types) int float bool str enum listOf attrsOf oneOf nullOr submodule;
-  inherit (lib.nvim.types) mkPluginSetupOption luaInline;
+  inherit (lib.nvim.types) mkPluginSetupOption luaInline borderType;
   inherit (lib.generators) mkLuaInline;
 in {
   imports = [
@@ -453,7 +453,7 @@ in {
           };
           border = mkOption {
             description = "Border style of the notification window";
-            type = enum ["none" "single" "double" "rounded" "solid" "shadow"];
+            type = borderType;
             default =
               if config.vim.ui.borders.enable
               then config.vim.ui.borders.globalStyle