Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

cloak

URL: https://github.com/laytan/cloak.nvim/

Maintainers: Gaetan Lepage


Cloak allows you to overlay *'s over defined patterns.

plugins.cloak.enable

Whether to enable cloak.

Type: boolean

Default: false

Example: true

Declared by:

plugins.cloak.package

The cloak package to use.

Type: package

Default: pkgs.vimPlugins.cloak-nvim

Declared by:

plugins.cloak.autoLoad

Whether to automatically load cloak when neovim starts.

Type: boolean

Default: false when lazy-loading is enabled.

Example: false

Declared by:

plugins.cloak.settings

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

Type: lua value

Default: { }

Example:

{
  cloak_character = "*";
  enabled = true;
  highlight_group = "Comment";
  patterns = [
    {
      cloak_pattern = "=.+";
      file_pattern = [
        ".env*"
        "wrangler.toml"
        ".dev.vars"
      ];
    }
  ];
}

Declared by: