erf / vis-highlight

highlight Lua patterns in vis

vis-highlight 🌈

A vis-plugin to highlight Lua patterns.

Commands

:hi [pattern] (style) - highlight a Lua pattern with optional style

:hi-ls - list patterns with style

:hi-clear - clear patterns

:hi-rm [pattern] - remove specific pattern

Example

:hi ' +\n' back:#444444
:hi-ls
:hi-rm " +\n"
:hi hi back:yellow,fore:blue,underlined:true,bold:true
:hi-clear

You only need quotation marks if you use spaces in your patterns

Patterns in visrc

You can set multiple patterns with style in your visrc.lua file with:

local hi = require('plugins/vis-highlight')
hi.patterns[' +\n'] = { style = 'back:#444444', hideOnInsert = true }
hi.patterns['hi'] = { style = 'back:yellow,fore:blue,underlined:true,bold:true' }

Notice the number of custom styles are limited to 64 and may be overridden by lexer styles

If pattern is set to empty {} it defaults to STYLE_CURSOR style.

You can set a hideOnInsert = true option to not highlight pattern when in vis.modes.INSERT.

See Patterns

Style definitions

Style definitions may contain the following:

• fore: Font face foreground color in 0xBBGGRR or "#RRGGBB" format.
• back: Font face background color in 0xBBGGRR or "#RRGGBB" format.
• bold: Whether or not the font face is bold. The default value is false.
• underlined: Whether or not the font face is underlined. The default value is false.

See LPegLexer

vis-highlight's Issues

Add license

Would be great to have a license: https://choosealicense.com/

Currently it's under no license, which means it gets default copyright under law, which is quite restrictive.

Second window does not use the same highlighting settings as the first

I assume that this is due to a misunderstanding on my part that I do not have the configuration properly setup. The problem is obvious from a picture:

My config:

-- load standard vis module, providing parts of the Lua API
require('vis')
local plug = require('plugins/vis-plug')

vis.events.subscribe(vis.events.INIT, function()
	-- Your global configuration options
	-- vis.hi.patterns['\t'] = { style = 'back:#ffffff' }
	plug.plugins.hi.patterns[' +\n'] = { style = 'back:#ff0000' }
	plug.plugins.hi.patterns['\t+'] = { style = 'fore:#303030' }
	plug.plugins.hi.patterns['\n'] = { style = 'fore:#303030' }
end)

vis.events.subscribe(vis.events.WIN_OPEN, function(win)
	-- Your per window configuration options e.g.
	-- vis:command('set number')
	vis:command('set show-tabs on')
	vis:command('set show-newlines on')
end)

-- configure plugins in an array of tables with git urls and options
local plugins = {

	-- load a plugin given a repo (https://github.com/ can be omitted and expects a 'init.lua' file)
	-- { 'erf/vis-cursors' },

	-- first parameter is a shorthand for 'url'
	{ url = 'erf/vis-cursors' },

	-- specify an alias to later use to access plugin variables (see example below)
	{ 'erf/vis-highlight', alias = 'hi' },

	-- configure themes by setting 'theme = true'. The theme 'file' will be set on INIT
	{ 'samlwood/vis-gruvbox', theme = true, file = 'gruvbox' },

	{ 'seifferth/vis-editorconfig' },
}

plug.init(plugins, true)