Merge 78c01d50ed into fd65c83956

* plugins/new-file-template: init module

* docs: add release note entry about new-file-template.nvim

* docs: update jacekpoz's link

* plugins/new-file-template: remove _: in default.nix

* plugins/new-file-template: add example for disableSpecific

* plugins/new-file-template: add docs on how to add custom templates

* plugins/new-file-template: fix disableSpecific example

* plugins/new-file-template: improve documentation

* plugins/new-file-template: remove redundant example

* plugins/new-file-template: more compact docs

* plugins/new-file-template: more doc improvements

* plugins/new-file-template: fix formatting issue

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

@@ -62,14 +62,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`.

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;
+    };
   };
 }

modules/default.nix

@@ -29,6 +29,8 @@ inputs: {
   # alias to the internal configuration
   vimOptions = module.config.vim;
 
+  luajit = vimOptions.package.lua;
+
   # build a vim plugin with the given name and arguments
   # if the plugin is nvim-treesitter, warn the user to use buildTreesitterPlug
   # instead
@@ -41,6 +43,8 @@ inputs: {
         inherit src;
 
         nativeBuildInputs = with pkgs.vimUtils; [
+          luajit
+
           vimCommandCheckHook
           vimGenDocHook
           neovimRequireCheckHook
@@ -102,12 +106,12 @@ inputs: {
 
   luaConfig =
     if vimOptions.byteCompileLua
-    then pkgs.runCommandLocal "init.lua" {text = vimOptions.builtLuaConfigRC;} "${pkgs.luajit}/bin/luajit -bd -- - $out <<< \"$text\""
+    then pkgs.runCommandLocal "init.lua" {text = vimOptions.builtLuaConfigRC;} "${luajit}/bin/luajit -bd -- - $out <<< \"$text\""
     else pkgs.writeText "init.lua" vimOptions.builtLuaConfigRC;
 
   extraLuaFiles =
     if vimOptions.byteCompileLua
-    then map (file: pkgs.runCommandLocal (baseNameOf file) {} "${pkgs.luajit}/bin/luajit -bd -- ${file} $out") vimOptions.extraLuaFiles
+    then map (file: pkgs.runCommandLocal (baseNameOf file) {} "${luajit}/bin/luajit -bd -- ${file} $out") vimOptions.extraLuaFiles
     else vimOptions.extraLuaFiles;
 
   # Wrap the user's desired (unwrapped) Neovim package with arguments that'll be used to

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";
+      };
+    };
+  };
+}