Cloak allows you to overlay *'s (or any other character) over defined patterns in defined files.
It also disables 'cmp' for the buffer(if it is installed).
Here is the default configuration.
'file_pattern' can be a string or table of strings, they should be valid autocommand patterns. 'cloak_pattern' is a lua pattern ran over every line in the buffer, overlaying 'cloak_character' over the match, excluding the first character.
require('cloak').setup({
enabled = true,
cloak_character = '*',
-- The applied highlight group (colors) on the cloaking, see `:h highlight`.
highlight_group = 'Comment',
patterns = {
{
-- Match any file starting with '.env'.
-- This can be a table to match multiple file patterns.
file_pattern = '.env*',
-- Match an equals sign and any character after it.
-- This can also be a table of patterns to cloak,
-- example: cloak_pattern = { ':.+', '-.+' } for yaml files.
cloak_pattern = '=.+'
},
},
})
The plugin automatically activates when a file matched by the patterns is opened.
You do have to call the 'setup()' function.
':CloakDisable', ':CloakEnable' and ':CloakToggle' are also available to toggle cloaking.