From ddbcec9a1c7e70c703b70a3c721e65273af77614 Mon Sep 17 00:00:00 2001 From: Barrett Ruth Date: Tue, 3 Feb 2026 16:24:11 -0500 Subject: [PATCH] fix(doc): warn about conflicting diff plugins --- README.md | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 0e4d2fc..8813ea2 100644 --- a/README.md +++ b/README.md @@ -39,11 +39,22 @@ luarocks install diffs.nvim ## Known Limitations -- `vim-fugitive` syntax "flashing": diffs.nvim hooks into the - `FileType fugitive` event triggered by vim-fugitive, at which point the buffer - is preliminarily painted. The buffer is then re-painted after `debounce_ms` - milliseconds, causing an unavoidable visual "flash" even when - `debounce_ms = 0`. +- **Syntax flashing**: diffs.nvim hooks into the `FileType fugitive` event + triggered by vim-fugitive, at which point the buffer is preliminarily painted. + The buffer is then re-painted after `debounce_ms` milliseconds, causing an + unavoidable visual "flash" even when `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