Merge pull request #29 from NotAShelf/feature/todo-comments.nvim

Feature/todo comments.nvim

extra.nix

@@ -147,6 +147,7 @@ inputs: let
         obsidian.enable = false; # FIXME neovim fails to build if obsidian is enabled
         orgmode.enable = false;
         mind-nvim.enable = true;
+        todo-comments.enable = true;
       };
 
       vim.terminal = {

lib/types-plugin.nix

@@ -71,6 +71,7 @@ with lib; let
     "mind-nvim"
     "fidget-nvim"
     "diffview-nvim"
+    "todo-comments"
   ];
   # You can either use the name of the plugin or a package.
   pluginsType = with types; listOf (nullOr (either (enum availablePlugins) package));

modules/notes/default.nix

@@ -3,5 +3,6 @@ _: {
     ./obsidian
     ./orgmode
     ./mind-nvim
+    ./todo-comments
   ];
 }

modules/notes/todo-comments/config.nix

@@ -0,0 +1,47 @@
+{
+  pkgs,
+  config,
+  lib,
+  ...
+}:
+with lib;
+with builtins; let
+  cfg = config.vim.notes.todo-comments;
+in {
+  config = mkIf (cfg.enable) {
+    vim.startPlugins = [
+      "todo-comments"
+    ];
+
+    vim.nnoremap = {
+      "<leader>tdq" = ":TodoQuickFix<CR>";
+      "<leader>tds" = ":TodoTelescope<CR>";
+      "<leader>tdt" = ":TodoTrouble<CR>";
+    };
+
+    vim.luaConfigRC.todo-comments = ''
+      require('todo-comments').setup {
+        highlight = {
+          before = "", -- "fg" or "bg" or empty
+          keyword = "bg", -- "fg", "bg", "wide" or empty
+          after = "fg", -- "fg" or "bg" or empty
+          pattern = ${cfg.patterns.highlight},
+          comments_only = true, -- uses treesitter to match keywords in comments only
+          max_line_len = 400, -- ignore lines longer than this
+          exclude = {}, -- list of file types to exclude highlighting
+        },
+        search = {
+          command = "${pkgs.ripgrep}/bin/rg",
+          args = {
+            "--color=never",
+            "--no-heading",
+            "--with-filename",
+            "--line-number",
+            "--column",
+          },
+          pattern = ${cfg.patterns.search},
+        },
+      }
+    '';
+  };
+}

modules/notes/todo-comments/default.nix

@@ -0,0 +1,6 @@
+_: {
+  imports = [
+    ./todo-comments.nix
+    ./config.nix
+  ];
+}

modules/notes/todo-comments/todo-comments.nix

@@ -0,0 +1,28 @@
+{
+  pkgs,
+  config,
+  lib,
+  ...
+}:
+with lib;
+with builtins; let
+  cfg = config.vim.notes.todo-comments;
+in {
+  options.vim.notes.todo-comments = {
+    enable = mkEnableOption "todo-comments";
+
+    patterns = {
+      highlight = mkOption {
+        type = types.str;
+        default = ''[[.*<(KEYWORDS)(\([^\)]*\))?:]]'';
+        description = "vim regex pattern used for highlighting comments";
+      };
+
+      search = mkOption {
+        type = types.str;
+        default = ''[[\b(KEYWORDS)(\([^\)]*\))?:]]'';
+        description = "ripgrep regex pattern used for searching comments";
+      };
+    };
+  };
+}