Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aileot/emission.nvim
✨ Highlight added/removed texts after any text manipulation
https://github.com/aileot/emission.nvim
neovim neovim-plugin nvim nvim-plugin
Last synced: about 1 month ago
JSON representation
✨ Highlight added/removed texts after any text manipulation
- Host: GitHub
- URL: https://github.com/aileot/emission.nvim
- Owner: aileot
- License: apache-2.0
- Created: 2024-11-30T03:13:38.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-12-01T01:22:42.000Z (about 1 month ago)
- Last Synced: 2024-12-01T01:24:13.092Z (about 1 month ago)
- Topics: neovim, neovim-plugin, nvim, nvim-plugin
- Language: Fennel
- Homepage:
- Size: 234 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- my-neovim-pluginlist - aileot/emission.nvim - commit/aileot/emission.nvim)  (Other Standard Feature Enhancement / Undo)
README
# ✨ emission.nvim
A generalized fork of
[tzachar/highlight-undo.nvim]
rewritten in Fennel with
[antifennel].
## Features
Unlike `highlight-undo.nvim` does, `emission.nvim` does NOT distinguish
`undo`/`redo`.
However, `emission.nvim` does provide the following features:
- Highlights for **added** texts.
- Highlights for **removed** texts like afterimage.
- **No** keymap conflicts.
## Demo
## Requirements
- Neovim >= 0.9.5
## Installation
Install the plugin with your favorite plugin-manger.
With [folke/lazy.nvim],
```lua
{
"aileot/emission.nvim",
event = "VeryLazy",
opts = {},
},
```
## Setup
Just set up the plugin as follows:
```lua
require("emission").setup()
```
The default settings:
```lua
require("emission").setup({
attach = {
-- Useful to avoid extra attaching attempts in simultaneous buffer editing
-- such as `:bufdo` or `:cdo`.
delay = 150,
excluded_buftypes = {
"help",
"nofile",
"terminal",
"prompt"
},
-- NOTE: Nothing is excluded by default. Add any as you need, but check
-- the 'buftype' at first.
excluded_filetypes = {
-- "oil",
},
},
highlight = {
duration = 300, -- milliseconds
min_byte = 2, -- minimum bytes to highlight texts
filter = function(buf) -- See below for examples.
return true
end,
-- NOTE: Buffer texts watched by emission.nvim are cached for the removed
-- text highlight feature when the buffer is attached and after each
-- set of highlight emissions.
-- However, `min_byte` and `filter` options are likely to prevent
-- necessary recaches. The default value "InsertLeave" forces texts to
-- be re-cached regardless of the option values.
-- Please add |autocmd-events| properly if emitted highlight texts are
-- outdated with your filter settings.
additional_recache_events = { "InsertLeave" },
},
added = {
priority = 102,
-- The options for `vim.api.nvim_set_hl(0, "EmissionAdded", {hl_map})`.
-- NOTE: If you keep "default" key set to `true`, you can arrange the
-- highlight groups hl-EmissionAdded by nvim_set_hl(), based on your
-- colorscheme.
-- NOTE: You can use "link" key to link the highlight settings to an
-- existing highlight group like hl-DiffAdd.
hl_map = {
default = true,
bold = true,
fg = "#dcd7ba",
bg = "#2d4f67",
},
},
-- The same options as `added` are available.
-- Note that the default values might be different from `added` ones.
removed = {
priority = 101,
-- The options for `vim.api.nvim_set_hl(0, "EmissionRemoved", {hl_map})`.
hl_map = {
default = true,
bold = true,
fg = "#dcd7ba",
bg = "#672d2d",
},
},
})
```
### Recommended filter settings
In the following example, highlighting is restricted to `normal` mode.
Additionally, it will never highlight during recorded macro execution.
```lua
---@param buf number attached buffer handle
---@return boolean Return false or nil to ignore; otherwise, highlight texts
local filter = function(buf)
-- Do not highlight during executing macro.
if vim.fn.reg_executing() ~= "" then
return false
end
-- Do not highlight except in Normal mode.
if not vim.api.nvim_get_mode().mode:find("n") then
return false
end
return true
end
require("emission").setup({
-- Set other options...
highlight = {
-- Set other options at `highlight`...
filter = filter,
},
})
```
## Highlights
### hl-EmissionAdded
The highlight group used to highlight added texts.
As you can see in the [Setup](#setup) snippet above, you can override the highlight
using `added.hl_map` field in `setup()`.
You can also customize the highlight with `vim.api.nvim_set_hl()` directly
to adapt the color to your favorite colorscheme.
### hl-EmissionRemoved
The highlight group used to highlight removed texts.
As you can see in the [Setup](#setup) snippet above, you can override the highlight
using `removed.hl_map` field in `setup()`.
You can also customize the highlight with `vim.api.nvim_set_hl()` directly
to adapt the color to your favorite colorscheme.
## Related Projects
- [tzachar/highlight-undo.nvim]
highlights texts added by pre-registered mappings.
- [yuki-yano/highlight-undo.nvim]
works on [denops.vim].
- [machakann/vim-highlightedundo]
is written in Vimscript.
[antifennel]: https://git.sr.ht/~technomancy/antifennel
[denops.vim]: https://github.com/vim-denops/denops.vim
[folke/lazy.nvim]: https://github.com/folke/lazy.nvim
[tzachar/highlight-undo.nvim]: https://github.com/tzachar/highlight-undo.nvim
[yuki-yano/highlight-undo.nvim]: https://github.com/yuki-yano/highlight-undo.nvim
[machakann/vim-highlightedundo]: https://github.com/machakann/vim-highlightedundo