modules: start breaking down core modules; simplify tree structure

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

@@ -0,0 +1,49 @@
+{
+  pkgs,
+  config,
+  lib,
+  ...
+}: let
+  inherit (lib) mkMerge mkBinding mkIf;
+
+  cfg = config.vim.notes.todo-comments;
+  self = import ./todo-comments.nix {inherit lib;};
+  mappings = self.options.vim.notes.todo-comments.mappings;
+in {
+  config = mkIf (cfg.enable) {
+    vim.startPlugins = [
+      "todo-comments"
+    ];
+
+    vim.maps.normal = mkMerge [
+      (mkBinding cfg.mappings.quickFix ":TodoQuickFix<CR>" mappings.quickFix.description)
+      (mkIf config.vim.telescope.enable (mkBinding cfg.mappings.telescope ":TodoTelescope<CR>" mappings.telescope.description))
+      (mkIf config.vim.lsp.trouble.enable (mkBinding cfg.mappings.trouble ":TodoTrouble<CR>" mappings.trouble.description))
+    ];
+
+    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/plugins/notes/todo-comments/default.nix

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

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

@@ -0,0 +1,27 @@
+{lib, ...}: let
+  inherit (lib) mkEnableOption mkOption types mkMappingOption;
+in {
+  options.vim.notes.todo-comments = {
+    enable = mkEnableOption "todo-comments: highlight and search for todo comments like TODO, HACK, BUG in your code base";
+
+    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";
+      };
+    };
+
+    mappings = {
+      quickFix = mkMappingOption "Open Todo-s in a quickfix list" "<leader>tdq";
+      telescope = mkMappingOption "Open Todo-s in telescope" "<leader>tds";
+      trouble = mkMappingOption "Open Todo-s in Trouble" "<leader>tdt";
+    };
+  };
+}