From ddbcec9a1c7e70c703b70a3c721e65273af77614 Mon Sep 17 00:00:00 2001 From: Barrett Ruth Date: Tue, 3 Feb 2026 16:24:11 -0500 Subject: [PATCH 1/3] 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 From bed98791e57b6d77d57a0a3903b738d04e922680 Mon Sep 17 00:00:00 2001 From: Barrett Ruth Date: Tue, 3 Feb 2026 16:24:22 -0500 Subject: [PATCH 2/3] fix(doc): warn about conflicting diff plugins --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 8813ea2..2ed84ee 100644 --- a/README.md +++ b/README.md @@ -39,10 +39,10 @@ luarocks install diffs.nvim ## Known Limitations -- **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: @@ -58,6 +58,6 @@ luarocks install diffs.nvim # Acknowledgements -- [vim-fugitive](https://github.com/tpope/vim-fugitive) -- [codediff.nvim](https://github.com/esmuellert/codediff.nvim) -- [diffview.nvim](https://github.com/sindrets/diffview.nvim) +- [`vim-fugitive`](https://github.com/tpope/vim-fugitive) +- [`codediff.nvim`](https://github.com/esmuellert/codediff.nvim) +- [`diffview.nvim`](https://github.com/sindrets/diffview.nvim) From de81fa26cf1edfae99e31db3ce43ccb523403583 Mon Sep 17 00:00:00 2001 From: Barrett Ruth Date: Tue, 3 Feb 2026 16:25:15 -0500 Subject: [PATCH 3/3] fix(doc): warn about conflicting diff plugins --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2ed84ee..bc88a99 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ **Syntax highlighting for diffs in Neovim** -Enhance vim-fugitive and Neovim's built-in diff mode with language-aware syntax -highlighting. +Enhance `vim-fugitive` and Neovim's built-in diff mode with language-aware +syntax highlighting. ![diffs.nvim preview](https://github.com/user-attachments/assets/d3d64c96-b824-4fcb-af7f-4aef3f7f498a) @@ -19,7 +19,7 @@ highlighting. ## Requirements - Neovim 0.9.0+ -- [vim-fugitive](https://github.com/tpope/vim-fugitive) (optional, for unified +- [`vim-fugitive`](https://github.com/tpope/vim-fugitive) (optional, for unified diff syntax highlighting) ## Installation