Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kevinhwang91/nvim-hlslens
Hlsearch Lens for Neovim
https://github.com/kevinhwang91/nvim-hlslens
lua neovim neovim-lua neovim-plugin nvim
Last synced: 6 days ago
JSON representation
Hlsearch Lens for Neovim
- Host: GitHub
- URL: https://github.com/kevinhwang91/nvim-hlslens
- Owner: kevinhwang91
- License: bsd-3-clause
- Created: 2020-11-15T18:11:55.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-16T14:44:25.000Z (26 days ago)
- Last Synced: 2024-11-21T02:35:00.049Z (21 days ago)
- Topics: lua, neovim, neovim-lua, neovim-plugin, nvim
- Language: Lua
- Homepage:
- Size: 177 KB
- Stars: 769
- Watchers: 6
- Forks: 11
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-neovim - kevinhwang91/nvim-hlslens - Helps you better glance searched information, seamlessly jump matched instances. (Search / PHP)
README
# nvim-hlslens
nvim-hlslens helps you better glance at matched information, seamlessly jump between matched
instances.
## Table of contents
- [Table of contents](#table-of-contents)
- [Features](#features)
- [Quickstart](#quickstart)
- [Requirements](#requirements)
- [Installation](#installation)
- [Minimal configuration](#minimal-configuration)
- [Usage](#usage)
- [Start hlslens](#start-hlslens)
- [Stop hlslens](#stop-hlslens)
- [Documentation](#documentation)
- [Setup and description](#setup-and-description)
- [Highlight](#highlight)
- [Commands](#commands)
- [API](#api)
- [Advanced configuration](#advanced-configuration)
- [Customize configuration](#customize-configuration)
- [Customize virtual text](#customize-virtual-text)
- [Integrate with other plugins](#integrate-with-other-plugins)
- [vim-asterisk](https://github.com/haya14busa/vim-asterisk)
- [nvim-ufo](https://github.com/kevinhwang91/nvim-ufo)
- [vim-visual-multi](https://github.com/mg979/vim-visual-multi)
- [Feedback](#feedback)
- [License](#license)
## Features
- Fully customizable style of virtual text
- Clear highlighting and virtual text when cursor is out of range
- Display search result dynamically while cursor is moving
- Display search result for the current matched instance while searching
- Display search result for some built-in commands that support incsearch (need Neovim 0.8.0)
> Need `vim.api.nvim_parse_cmd` to parse built-in commands if incsearch is enabled.
## Quickstart
### Requirements
- [Neovim](https://github.com/neovim/neovim) 0.7.2 or later
- [nvim-ufo](https://github.com/kevinhwang91/nvim-ufo) (optional)
### Installation
Install nvim-hlslens with [Packer.nvim](https://github.com/wbthomason/packer.nvim):
```lua
use {'kevinhwang91/nvim-hlslens'}
```
### Minimal configuration
```lua
require('hlslens').setup()
local kopts = {noremap = true, silent = true}
vim.api.nvim_set_keymap('n', 'n',
[[execute('normal! ' . v:count1 . 'n')lua require('hlslens').start()]],
kopts)
vim.api.nvim_set_keymap('n', 'N',
[[execute('normal! ' . v:count1 . 'N')lua require('hlslens').start()]],
kopts)
vim.api.nvim_set_keymap('n', '*', [[*lua require('hlslens').start()]], kopts)
vim.api.nvim_set_keymap('n', '#', [[#lua require('hlslens').start()]], kopts)
vim.api.nvim_set_keymap('n', 'g*', [[g*lua require('hlslens').start()]], kopts)
vim.api.nvim_set_keymap('n', 'g#', [[g#lua require('hlslens').start()]], kopts)
vim.api.nvim_set_keymap('n', 'l', 'noh', kopts)
```
### Usage
After using [Minimal configuration](#minimal-configuration):
Hlslens will add virtual text at the end of the line if the room is enough for virtual text,
otherwise, add a floating window to overlay the statusline to display lens.
You can glance at the result provided by lens while searching when `incsearch` is on. Hlslens also
supports `` and `` to move to the next and previous match.
#### Start hlslens
1. Press `/` or `?` to search text, `/s` and `/e` offsets are supported;
2. Invoke API `require('hlslens').start()`;
#### Stop hlslens
1. Run ex command `nohlsearch`;
2. Map key to `:nohlsearch`;
3. Invoke API `require('hlslens').stop()`;
## Documentation
### Setup and description
```lua
{
auto_enable = {
description = [[Enable nvim-hlslens automatically]],
default = true
},
enable_incsearch = {
description = [[When `incsearch` option is on and enable_incsearch is true, add lens
for the current matched instance]],
default = true
},
calm_down = {
description = [[If calm_down is true, clear all lens and highlighting When the cursor is
out of the position range of the matched instance or any texts are changed]],
default = false,
},
nearest_only = {
description = [[Only add lens for the nearest matched instance and ignore others]],
default = false
},
nearest_float_when = {
description = [[When to open the floating window for the nearest lens.
'auto': floating window will be opened if room isn't enough for virtual text;
'always': always use floating window instead of virtual text;
'never': never use floating window for the nearest lens]],
default = 'auto',
},
float_shadow_blend = {
description = [[Winblend of the nearest floating window. `:h winbl` for more details]],
default = 50,
},
virt_priority = {
description = [[Priority of virtual text, set it lower to overlay others.
`:h nvim_buf_set_extmark` for more details]],
default = 100,
},
override_lens = {
description = [[Hackable function for customizing the lens. If you like hacking, you
should search `override_lens` and inspect the corresponding source code.
There's no guarantee that this function will not be changed in the future. If it is
changed, it will be listed in the CHANGES file.
@param render table an inner module for hlslens, use `setVirt` to set virtual text
@param splist table (1,1)-indexed position
@param nearest boolean whether nearest lens
@param idx number nearest index in the plist
@param relIdx number relative index, negative means before current position,
positive means after
]],
default = nil
},
}
```
### Highlight
```vim
hi default link HlSearchNear CurSearch
hi default link HlSearchLens WildMenu
hi default link HlSearchLensNear CurSearch
```
1. HlSearchLensNear: highlight the nearest virtual text for the floating window
2. HlSearchLens: highlight virtual text except for the nearest one
3. HlSearchNear: highlight the nearest matched instance
### Commands
- `HlSearchLensToggle`: Toggle nvim-hlslens enable/disable
- `HlSearchLensEnable`: Enable nvim-hlslens
- `HlSearchLensDisable`: Disable nvim-hlslens
### API
[hlslens.lua](./lua/hlslens.lua)
## Advanced configuration
### Customize configuration
```lua
require('hlslens').setup({
calm_down = true,
nearest_only = true,
nearest_float_when = 'always'
})
-- run `:nohlsearch` and export results to quickfix
-- if Neovim is 0.8.0 before, remap yourself.
vim.keymap.set({'n', 'x'}, 'L', function()
vim.schedule(function()
if require('hlslens').exportLastSearchToQuickfix() then
vim.cmd('cw')
end
end)
return ':noh'
end, {expr = true})
```
### Customize virtual text
```lua
require('hlslens').setup({
override_lens = function(render, posList, nearest, idx, relIdx)
local sfw = vim.v.searchforward == 1
local indicator, text, chunks
local absRelIdx = math.abs(relIdx)
if absRelIdx > 1 then
indicator = ('%d%s'):format(absRelIdx, sfw ~= (relIdx > 1) and '▲' or '▼')
elseif absRelIdx == 1 then
indicator = sfw ~= (relIdx == 1) and '▲' or '▼'
else
indicator = ''
end
local lnum, col = unpack(posList[idx])
if nearest then
local cnt = #posList
if indicator ~= '' then
text = ('[%s %d/%d]'):format(indicator, idx, cnt)
else
text = ('[%d/%d]'):format(idx, cnt)
end
chunks = {{' '}, {text, 'HlSearchLensNear'}}
else
text = ('[%s %d]'):format(indicator, idx)
chunks = {{' '}, {text, 'HlSearchLens'}}
end
render.setVirt(0, lnum - 1, col - 1, chunks, nearest)
end
})
```
### Integrate with other plugins
#### [vim-asterisk](https://github.com/haya14busa/vim-asterisk)
```lua
-- packer
use 'haya14busa/vim-asterisk'
vim.api.nvim_set_keymap('n', '*', [[(asterisk-z*)lua require('hlslens').start()]], {})
vim.api.nvim_set_keymap('n', '#', [[(asterisk-z#)lua require('hlslens').start()]], {})
vim.api.nvim_set_keymap('n', 'g*', [[(asterisk-gz*)lua require('hlslens').start()]], {})
vim.api.nvim_set_keymap('n', 'g#', [[(asterisk-gz#)lua require('hlslens').start()]], {})
vim.api.nvim_set_keymap('x', '*', [[(asterisk-z*)lua require('hlslens').start()]], {})
vim.api.nvim_set_keymap('x', '#', [[(asterisk-z#)lua require('hlslens').start()]], {})
vim.api.nvim_set_keymap('x', 'g*', [[(asterisk-gz*)lua require('hlslens').start()]], {})
vim.api.nvim_set_keymap('x', 'g#', [[(asterisk-gz#)lua require('hlslens').start()]], {})
```
#### [nvim-ufo](https://github.com/kevinhwang91/nvim-ufo)
The lens has been adapted to the folds of nvim-ufo, still need remap `n` and `N` action if you want
to peek at folded lines.
```lua
-- packer
use {'kevinhwang91/nvim-ufo', requires = 'kevinhwang91/promise-async'}
-- if Neovim is 0.8.0 before, remap yourself.
local function nN(char)
local ok, winid = hlslens.nNPeekWithUFO(char)
if ok and winid then
-- Safe to override buffer scope keymaps remapped by ufo,
-- ufo will restore previous buffer keymaps before closing preview window
-- Type will switch to preview window and fire `trace` action
vim.keymap.set('n', '', function()
return ''
end, {buffer = true, remap = true, expr = true})
end
end
vim.keymap.set({'n', 'x'}, 'n', function() nN('n') end)
vim.keymap.set({'n', 'x'}, 'N', function() nN('N') end)
```
#### [vim-visual-multi](https://github.com/mg979/vim-visual-multi)
```lua
-- packer
use 'mg979/vim-visual-multi'
local hlslens = require('hlslens')
if hlslens then
local overrideLens = function(render, posList, nearest, idx, relIdx)
local _ = relIdx
local lnum, col = unpack(posList[idx])
local text, chunks
if nearest then
text = ('[%d/%d]'):format(idx, #posList)
chunks = {{' ', 'Ignore'}, {text, 'VM_Extend'}}
else
text = ('[%d]'):format(idx)
chunks = {{' ', 'Ignore'}, {text, 'HlSearchLens'}}
end
render.setVirt(0, lnum - 1, col - 1, chunks, nearest)
end
local lensBak
local config = require('hlslens.config')
local gid = vim.api.nvim_create_augroup('VMlens', {})
vim.api.nvim_create_autocmd('User', {
pattern = {'visual_multi_start', 'visual_multi_exit'},
group = gid,
callback = function(ev)
if ev.match == 'visual_multi_start' then
lensBak = config.override_lens
config.override_lens = overrideLens
else
config.override_lens = lensBak
end
hlslens.start()
end
})
end
```
## Feedback
- If you get an issue or come up with an awesome idea, don't hesitate to open an issue in github.
- If you think this plugin is useful or cool, consider rewarding it a star.
## License
The project is licensed under a BSD-3-clause license. See [LICENSE](./LICENSE) file for details.