plugins.todo-comments.keywords

Configurations for keywords to be recognized as todo comments.

Default:

{
  FIX = {
    icon = " "; # Icon used for the sign, and in search results.
    color = "error"; # Can be a hex color, or a named color.
    alt = [ "FIXME" "BUG" "FIXIT" "ISSUE" ]; # A set of other keywords that all map to this FIX keywords.
  };
  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" ]; };
};

Type: null or (attribute set of (submodule))

Default: null

Declared by:

plugins.todo-comments.keywords.<name>.alt

A set of other keywords that all map to this FIX keywords.

Type: null or (list of string)

Default: null

Declared by:

plugins.todo-comments.keywords.<name>.color

Can be a hex color, or a named color.

Type: null or string

Default: null

Declared by:

plugins.todo-comments.keywords.<name>.icon

Icon used for the sign, and in search results.

Type: null or string

Default: null

Declared by:

plugins.todo-comments.keywords.<name>.signs

Configure signs for some keywords individually.

Type: null or boolean

Default: null

Declared by: