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:

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:

plugins.todo-comments.settings.merge_keywords

When true, custom keywords will be merged with the default.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.todo-comments.settings.sign_priority

Sign priority.

Type: null or signed integer or floating point number or raw lua code

Default: null

Plugin default: 8

Declared by:

plugins.todo-comments.settings.signs

Show icons in the signs column.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by: