settings - nixvim docs

plugins.todo-comments.settings

Options provided to the require('todo-comments').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  highlight = {
    pattern = [
      ".*<(KEYWORDS)s*:"
      ".*<(KEYWORDS)s*"
    ];
  };
}

Declared by:

<nixvim/plugins/by-name/todo-comments>

plugins.todo-comments.settings.colors

List of named colors where we try to extract the guifg from the list of highlight groups or use the hex color if hl not found as a fallback.

Type: null or (attribute set of ((list of string) or raw lua code))

Default: null

Plugin default:

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

Declared by:

<nixvim/plugins/by-name/todo-comments>

plugins.todo-comments.settings.keywords

Configurations for keywords to be recognized as todo comments.

Type: null or (attribute set of ((attribute set of anything) or raw lua code))

Default: null

Plugin default:

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

Declared by: