A Neovim plugin that visualizes undo/redo operations by highlighting the text differences. This plugin makes it easy to see what changes when you undo or redo, improving your editing workflow.
- 🎯 Visual Feedback: Instantly see what text was added or removed during undo/redo
- ⚡ High Performance: Optimized for large files with efficient diff algorithms
- 🌏 Multi-byte Support: Full support for Unicode, including CJK characters and emojis
- 🎨 Customizable: Configure highlight colors, duration, and behavior
- 🔧 Smart Thresholds: Automatically skips highlighting for massive changes to maintain performance
- ✨ Intuitive Highlighting: Smart adjustments for word boundaries and whitespace changes
- Neovim >= 0.8.0
- denops.vim - The powerful ecosystem for Vim/Neovim
- Deno - Required by denops.vim
Using lazy.nvim:
{
'yuki-yano/highlight-undo.nvim',
dependencies = {
'vim-denops/denops.vim',
},
config = function()
require('highlight-undo').setup({})
end,
}highlight-undo-demo.mp4
The plugin provides sensible defaults but can be customized to your preferences:
require('highlight-undo').setup({
-- Key mappings
mappings = {
undo = 'u', -- Key for undo with highlight
redo = '<C-r>', -- Key for redo with highlight
},
-- What to highlight
enabled = {
added = true, -- Highlight added text
removed = true, -- Highlight removed text
},
-- Highlight groups
highlight = {
added = 'DiffAdd', -- Highlight group for added text
removed = 'DiffDelete', -- Highlight group for removed text
},
-- Performance thresholds
threshold = {
line = 50, -- Skip highlighting if more than 50 lines changed
char = 1500, -- Skip highlighting if more than 1500 characters changed
},
-- Highlight duration
duration = 200, -- Duration in milliseconds
-- Debug mode
debug = false, -- Enable debug logging for troubleshooting
-- Range adjustments for more intuitive highlighting
rangeAdjustments = {
adjustWordBoundaries = true, -- Expand highlights to word boundaries
handleWhitespace = true, -- Special handling for whitespace changes
},
-- Heuristic display strategies
heuristics = {
enabled = true,
-- Change size thresholds (in characters)
thresholds = {
tiny = 5, -- Changes <= 5 chars
small = 20, -- Changes <= 20 chars
medium = 100, -- Changes <= 100 chars
},
-- Display strategies for each size
strategies = {
tiny = "character", -- Show exact character changes
small = "word", -- Expand to word boundaries
medium = "line", -- Highlight full lines
large = "block", -- Highlight blocks of lines
},
},
})The plugin provides commands for runtime control:
" Disable highlight-undo temporarily
:lua require('highlight-undo').disable()
" Re-enable highlight-undo
:lua require('highlight-undo').enable()
" Toggle highlight-undo on/off
:lua require('highlight-undo').toggle()Advanced debugging commands for troubleshooting:
-- Get performance statistics
:lua require('highlight-undo').debug.get_stats()
-- Clear all caches
:lua require('highlight-undo').debug.clear_cache()
-- Enable/disable debug mode at runtime
:lua require('highlight-undo').debug.enable_debug()
:lua require('highlight-undo').debug.disable_debug()
-- Show current configuration
:lua require('highlight-undo').debug.show_config()Monitor plugin performance and cache usage:
-- Get performance statistics
local stats = require('highlight-undo').get_stats()
-- Returns detailed statistics about buffer cache and performance
-- Clear all buffer caches manually
require('highlight-undo').clear_cache()You can define custom highlight groups for better visual distinction:
" Define custom highlight groups
highlight HighlightUndoAdded guibg=#2d4f2d guifg=#a3d3a3
highlight HighlightUndoRemoved guibg=#4f2d2d guifg=#d3a3a3
" Use them in setup
lua require('highlight-undo').setup({
highlight = {
added = 'HighlightUndoAdded',
removed = 'HighlightUndoRemoved',
}
})The plugin uses intelligent heuristics to display changes in the most intuitive way:
- Tiny changes (1-5 chars): Show exact character-level changes
- Small changes (5-20 chars): Expand to word boundaries for better context
- Medium changes (20-100 chars): Highlight entire lines
- Large changes (100+ chars): Group consecutive lines into blocks
This adaptive approach ensures that:
- Small typo fixes are precisely highlighted
- Word replacements show complete words
- Line edits are clearly visible
- Large refactorings are shown as cohesive blocks
This plugin is designed for performance:
- Smart Caching: Buffer states are cached to minimize computation
- Diff Optimization: Uses efficient algorithms optimized for common editing patterns
- Batch Operations: Highlights are applied in batches to reduce API calls
- Memory Management: Automatic cache eviction prevents memory bloat
- Concurrent Safety: Thread-safe operations prevent race conditions
Enable debug mode to diagnose issues:
require('highlight-undo').setup({
debug = true,
-- Optional: specify a log file
logFile = vim.fn.stdpath('data') .. '/highlight-undo.log',
})- Highlights not appearing: Check if denops.vim is properly installed and running
- Performance issues: Adjust the
thresholdvalues for your use case - Encoding issues: The plugin handles multi-byte characters automatically
Contributions are welcome! Please feel free to submit issues or pull requests.
# Run tests
deno task test
# Format code
deno fmt
# Type check
deno check denops/highlight-undo/main.ts
# Format Lua code
stylua lua/
# Run performance benchmarks
deno run --allow-all denops/highlight-undo/performance-benchmark.tsMIT License - see LICENSE file for details
- Built with denops.vim - the excellent Deno-based plugin framework
- Inspired by the need for better visual feedback in Vim's undo system