plugins.precognition.settings

Options provided to the require('precognition').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  disabled_fts = [
    "startify"
    "dashboard"
  ];
  highlightColor = {
    link = "Text";
  };
  showBlankVirtLine = false;
  startVisible = false;
}

Declared by:

plugins.precognition.settings.disabled_fts

precognition.nvim is disabled under these filetypes.

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

Default: null

Plugin default:

[
  "startify"
]

Declared by:

plugins.precognition.settings.gutterHints

Hints that will be shown on the gutter.

Hints can be hidden by setting their priority to 0.

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

Default: null

Plugin default:

{
  G = {
    prio = 10;
    text = "G";
  };
  NextParagraph = {
    prio = 8;
    text = "}";
  };
  PrevParagraph = {
    prio = 8;
    text = "{";
  };
  gg = {
    prio = 9;
    text = "gg";
  };
}

Declared by:

plugins.precognition.settings.highlightColor

Highlight groups for the hints.

Can be defined as either:

  • As a table containing a link property pointing to an existing highlight group.
  • As a table specifying custom highlight values, such as foreground and background colors.

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

Default: null

Plugin default:

{
  link = "Comment";
}

Declared by:

plugins.precognition.settings.hints

Hints that will be shown on the virtual line. Priority is used to determine which hint to show when two can be shown at the same spot.

Hints can be hidden by setting their priority to 0. If you want to hide the entire virtual line, set all elements to prio = 0.

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

Default: null

Plugin default:

{
  B = {
    prio = 6;
    text = "B";
  };
  Caret = {
    prio = 2;
    text = "^";
  };
  Dollar = {
    prio = 1;
    text = "$";
  };
  E = {
    prio = 5;
    text = "E";
  };
  MatchingPair = {
    prio = 5;
    text = "%";
  };
  W = {
    prio = 7;
    text = "W";
  };
  Zero = {
    prio = 1;
    text = "0";
  };
  b = {
    prio = 9;
    text = "b";
  };
  e = {
    prio = 8;
    text = "e";
  };
  w = {
    prio = 10;
    text = "w";
  };
}

Declared by:

plugins.precognition.settings.showBlankVirtLine

Setting this option will mean that if a Virtual Line would be blank it won’t be rendered.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.precognition.settings.startVisible

Whether to show precognition.nvim on startup.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by: