From 2e5400f9c0699bf8a8935a5741210f84f544385b Mon Sep 17 00:00:00 2001 From: Barrett Ruth Date: Tue, 3 Feb 2026 01:33:31 -0500 Subject: [PATCH 1/3] fix(doc): move hl documentation to the vimdoc --- README.md | 20 -------------------- doc/diffs.nvim.txt | 21 +++++++++++++-------- 2 files changed, 13 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 30ee301..440be8a 100644 --- a/README.md +++ b/README.md @@ -40,26 +40,6 @@ Using [lazy.nvim](https://github.com/folke/lazy.nvim): :help diffs.nvim ``` -## Highlight Groups - -diffs.nvim defines the following highlight groups. All use `default = true`, so -colorschemes can override them. - -| Group | Purpose | -| ----------------- | -------------------------------------------------- | -| `DiffsAdd` | Background for `+` lines in fugitive unified diffs | -| `DiffsDelete` | Background for `-` lines in fugitive unified diffs | -| `DiffsAddNr` | Line number highlight for `+` lines | -| `DiffsDeleteNr` | Line number highlight for `-` lines | -| `DiffsDiffAdd` | Background-only `DiffAdd` for `&diff` windows | -| `DiffsDiffDelete` | Background-only `DiffDelete` for `&diff` windows | -| `DiffsDiffChange` | Background-only `DiffChange` for `&diff` windows | -| `DiffsDiffText` | Background-only `DiffText` for `&diff` windows | - -By default, these are computed from your colorscheme's `DiffAdd`, `DiffDelete`, -`DiffChange`, `DiffText`, and `Normal` groups. To customize, define them in your -colorscheme before diffs.nvim loads, or link them to existing groups. - ## Known Limitations - Syntax "flashing": diffs.nvim hooks into the `FileType fugitive` event diff --git a/doc/diffs.nvim.txt b/doc/diffs.nvim.txt index 9535cb0..1916683 100644 --- a/doc/diffs.nvim.txt +++ b/doc/diffs.nvim.txt @@ -194,8 +194,9 @@ To minimize the flash, use a low debounce value: >lua ============================================================================== HIGHLIGHT GROUPS *diffs-highlights* -diffs.nvim defines custom highlight groups. All are set with `default = true`, -so colorschemes can override them by defining them first. +diffs.nvim defines custom highlight groups. Fugitive unified diff groups use +`default = true`, so colorschemes can override them. Diff mode groups are +always derived from the corresponding `Diff*` groups. Fugitive unified diff highlights: ~ *DiffsAdd* @@ -215,20 +216,24 @@ Fugitive unified diff highlights: ~ `diffRemoved`, background from `DiffsDelete`. Diff mode window highlights: ~ -These are background-only variants used for |winhighlight| remapping in -`&diff` windows, allowing treesitter syntax to show through. +These are used for |winhighlight| remapping in `&diff` windows. *DiffsDiffAdd* - DiffsDiffAdd Background-only version of `DiffAdd`. + DiffsDiffAdd Background-only. Derived from `DiffAdd` bg. + Treesitter provides foreground syntax highlighting. *DiffsDiffDelete* - DiffsDiffDelete Background-only version of `DiffDelete`. + DiffsDiffDelete Foreground and background from `DiffDelete`. + Used for filler lines (`/////`) which have no real + code content to highlight. *DiffsDiffChange* - DiffsDiffChange Background-only version of `DiffChange`. + DiffsDiffChange Background-only. Derived from `DiffChange` bg. + Treesitter provides foreground syntax highlighting. *DiffsDiffText* - DiffsDiffText Background-only version of `DiffText`. + DiffsDiffText Background-only. Derived from `DiffText` bg. + Treesitter provides foreground syntax highlighting. To customize these in your colorscheme: >lua vim.api.nvim_set_hl(0, 'DiffsAdd', { bg = '#2e4a3a' }) From 580fb5e5be0b9ce972f50401ce7333ed79d19abe Mon Sep 17 00:00:00 2001 From: Barrett Ruth Date: Tue, 3 Feb 2026 01:36:54 -0500 Subject: [PATCH 2/3] fix: ci --- .github/workflows/quality.yaml | 1 + README.md | 6 ++++++ 2 files changed, 7 insertions(+) diff --git a/.github/workflows/quality.yaml b/.github/workflows/quality.yaml index 54c4e82..77049fd 100644 --- a/.github/workflows/quality.yaml +++ b/.github/workflows/quality.yaml @@ -1,6 +1,7 @@ name: quality on: + workflow_call: pull_request: branches: [main] push: diff --git a/README.md b/README.md index 440be8a..f656d17 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,12 @@ Using [lazy.nvim](https://github.com/folke/lazy.nvim): } ``` +Or via [luarocks](https://luarocks.org/modules/barrettruth/diffs.nvim): + +``` +luarocks install diffs.nvim +``` + ## Documentation ```vim From 259763ade405d9bb4503c01c5e18cfa412d0925c Mon Sep 17 00:00:00 2001 From: Barrett Ruth Date: Tue, 3 Feb 2026 01:40:27 -0500 Subject: [PATCH 3/3] prefer luarocks install --- README.md | 13 ++----------- 1 file changed, 2 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index f656d17..49eaa5a 100644 --- a/README.md +++ b/README.md @@ -24,17 +24,8 @@ highlighting. ## Installation -Using [lazy.nvim](https://github.com/folke/lazy.nvim): - -```lua -{ - 'barrettruth/diffs.nvim', - dependencies = { 'tpope/vim-fugitive' }, - opts = {}, -} -``` - -Or via [luarocks](https://luarocks.org/modules/barrettruth/diffs.nvim): +Install with your package manager of choice or via +[luarocks](https://luarocks.org/modules/barrettruth/diffs.nvim): ``` luarocks install diffs.nvim