nix-community.nixvim/tests/test-sources/plugins/utils/todo-comments.nix

{
  # Empty configuration
  empty = {
    plugins.todo-comments.enable = true;
  };

  # All the upstream default options of todo-comments
  defaults = {
    plugins.todo-comments = {
      enable = true;

      signs = true;
      signPriority = 8;

      keywords = {
        FIX = {
          icon = " ";
          color = "error";
          alt = ["FIXME" "BUG" "FIXIT" "ISSUE"];
          signs = false;
        };
        TODO = {
          icon = " ";
          color = "info";
        };
        HACK = {
          icon = " ";
          color = "warning";
        };
        WARN = {
          icon = " ";
          color = "warning";
          alt = ["WARNING" "XXX"];
        };
        PERF = {
          icon = " ";
          alt = ["OPTIM" "PERFORMANCE" "OPTIMIZE"];
        };
        NOTE = {
          icon = " ";
          color = "hint";
          alt = ["INFO"];
        };
        TEST = {
          icon = "⏲ ";
          color = "test";
          alt = ["TESTING" "PASSED" "FAILED"];
        };
      };

      guiStyle = {
        fg = "NONE";
        bg = "BOLD";
      };

      mergeKeywords = true;

      highlight = {
        multiline = true;
        multilinePattern = "^.";
        multilineContext = 10;
        before = "";
        keyword = "wide";
        after = "fg";
        pattern = ''.*<(KEYWORDS)\s*:'';
        commentsOnly = true;
        maxLineLen = 400;
        exclude = [];
      };

      colors = {
        error = ["DiagnosticError" "ErrorMsg" "#DC2626"];
        warning = ["DiagnosticWarn" "WarningMsg" "#FBBF24"];
        info = ["DiagnosticInfo" "#2563EB"];
        hint = ["DiagnosticHint" "#10B981"];
        default = ["Identifier" "#7C3AED"];
        test = ["Identifier" "#FF00FF"];
      };

      search = {
        command = "rg";
        args = [
          "--color=never"
          "--no-heading"
          "--with-filename"
          "--line-number"
          "--column"
        ];
        pattern = ''\b(KEYWORDS):'';
      };

      keymaps = {
        todoQuickFix.key = "<C-a>";
        todoLocList = {
          key = "<C-f>";
          cwd = "~/projects/foobar";
          keywords = "TODO,FIX";
          options.silent = true;
        };
        todoTrouble = {
          key = "<C-t>";
          keywords = "TODO,FIX";
        };
        todoTelescope = {
          key = "<C-e>";
          cwd = "~/projects/foobar";
        };
      };
    };
  };

  keymapsOptions = {
    plugins.todo-comments = {
      enable = true;

      keymaps = {
        todoTrouble = {
          key = "<C-f>";
          keywords = "TODO,FIX";
          options = {
            desc = "Description for todoTrouble";
            silent = true;
          };
        };
      };
    };
  };
}