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:

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

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

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

Default: null

Plugin default: null

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

Can be a hex color, or a named color.

Type: null or string or raw lua code

Default: null

Plugin default: null

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

Icon used for the sign, and in search results.

Type: null or string or raw lua code

Default: null

Plugin default: null

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

Configure signs for some keywords individually.

Type: null or boolean or raw lua code

Default: null

Plugin default: null