barrett/diffs.nvim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix(doc): warn about conflicting diff plugins

Browse source
This commit is contained in:
Barrett Ruth 2026-02-03 16:24:11 -05:00
parent c7dcfc4099
commit ddbcec9a1c
1 changed files with 16 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -39,11 +39,22 @@ luarocks install diffs.nvim
## Known Limitations ## Known Limitations
- `vim-fugitive` syntax "flashing": diffs.nvim hooks into the - **Syntax flashing**: diffs.nvim hooks into the `FileType fugitive` event
`FileType fugitive` event triggered by vim-fugitive, at which point the buffer triggered by vim-fugitive, at which point the buffer is preliminarily painted.
is preliminarily painted. The buffer is then re-painted after `debounce_ms` The buffer is then re-painted after `debounce_ms` milliseconds, causing an
milliseconds, causing an unavoidable visual "flash" even when unavoidable visual "flash" even when `debounce_ms = 0`.
`debounce_ms = 0`.
- **Conflicting diff plugins**: `diffs.nvim` may not interact well with other
plugins that modify diff highlighting. Known plugins that may conflict:
- [`diffview.nvim`](https://github.com/sindrets/diffview.nvim) - provides its
own diff highlighting and conflict resolution UI
- [`mini.diff`](https://github.com/echasnovski/mini.diff) - visualizes buffer
differences with its own highlighting system
- [`gitsigns.nvim`](https://github.com/lewis6991/gitsigns.nvim) - generally
compatible, but both plugins modifying line highlights may produce
unexpected results
- [`git-conflict.nvim`](https://github.com/akinsho/git-conflict.nvim) -
conflict marker highlighting may overlap with `diffs.nvim`
# Acknowledgements # Acknowledgements