Skip to content

Commit baf10db

Browse files
authored
docs: update references to diffview-plus.nvim (#566)
Document that dlyongemallo's fork has been renamed. Also, add a health check that verifies if the recommended (but not required) diffview.api package is present.
1 parent f06f97b commit baf10db

4 files changed

Lines changed: 14 additions & 10 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ With <a href="https://github.com/folke/lazy.nvim">Lazy</a>:
4141
dependencies = {
4242
"MunifTanjim/nui.nvim",
4343
"nvim-lua/plenary.nvim",
44-
"dlyongemallo/diffview.nvim", -- Maintained fork of "sindrets/diffview.nvim".
44+
"dlyongemallo/diffview-plus.nvim", -- Maintained fork of "sindrets/diffview.nvim".
4545
"stevearc/dressing.nvim", -- Recommended but not required. Better UI for pickers.
4646
"nvim-tree/nvim-web-devicons", -- Recommended but not required. Icons in discussion tree.
4747
},
@@ -60,7 +60,7 @@ And with <a href="https://github.com/lewis6991/pckr.nvim">pckr.nvim</a>:
6060
requires = {
6161
"MunifTanjim/nui.nvim",
6262
"nvim-lua/plenary.nvim",
63-
"dlyongemallo/diffview.nvim", -- Maintained fork of "sindrets/diffview.nvim".
63+
"dlyongemallo/diffview-plus.nvim", -- Maintained fork of "sindrets/diffview.nvim".
6464
"stevearc/dressing.nvim", -- Recommended but not required. Better UI for pickers.
6565
"nvim-tree/nvim-web-devicons", -- Recommended but not required. Icons in discussion tree.
6666
},
@@ -74,7 +74,7 @@ And with <a href="https://github.com/lewis6991/pckr.nvim">pckr.nvim</a>:
7474

7575
Add `branch = "develop",` to your configuration if you want to use the (possibly unstable) development version of `gitlab.nvim`.
7676

77-
`gitlab.nvim` uses the `diffview.nvim` plugin for showing the diffs in a MR. We recommend using [dlyongemallo's](https://github.com/dlyongemallo/diffview.nvim) fork which is the de-facto maintained version of the plugin with many fixes and improvements (e.g., marking files as viewed).
77+
`gitlab.nvim` uses the `diffview.nvim` plugin for showing the diffs in a MR. We recommend using `dlyongemallo`'s [diffview+](https://github.com/dlyongemallo/diffview-plus.nvim) fork which is the de-facto maintained version of the plugin with many fixes and improvements (e.g., marking files as viewed). The original [sindrets/diffview.nvim](https://github.com/sindrets/diffview.nvim) plugin will be supported as long as the maintenance remains feasible.
7878

7979
## Contributing
8080

doc/gitlab.nvim.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ With Lazy:
6464
dependencies = {
6565
"MunifTanjim/nui.nvim",
6666
"nvim-lua/plenary.nvim",
67-
"dlyongemallo/diffview.nvim", -- Maintained fork of "sindrets/diffview.nvim".
67+
"dlyongemallo/diffview-plus.nvim", -- Maintained fork of "sindrets/diffview.nvim".
6868
"stevearc/dressing.nvim", -- Recommended but not required. Better UI for pickers.
6969
"nvim-tree/nvim-web-devicons", -- Recommended but not required. Icons in discussion tree.
7070
},
@@ -81,7 +81,7 @@ And with pckr.nvim:
8181
requires = {
8282
"MunifTanjim/nui.nvim",
8383
"nvim-lua/plenary.nvim",
84-
"dlyongemallo/diffview.nvim", -- Maintained fork of "sindrets/diffview.nvim".
84+
"dlyongemallo/diffview-plus.nvim", -- Maintained fork of "sindrets/diffview.nvim".
8585
"stevearc/dressing.nvim", -- Recommended but not required. Better UI for pickers.
8686
"nvim-tree/nvim-web-devicons", -- Recommended but not required. Icons in discussion tree.
8787
},
@@ -864,9 +864,9 @@ plugin is loaded. If run twice, will open a second reviewer pane.
864864
*gitlab.nvim.reload_review*
865865
gitlab.reload_review() ~
866866

867-
Loads new MR state from Gitlab. Then if diffview.api is available (with the
868-
https://github.com/dlyongemallo/diffview.nvim fork) applies the new diff refs
869-
to the existing diffview, otherwise (with
867+
Loads new MR state from Gitlab. Then if `diffview.api` is available (with the
868+
https://github.com/dlyongemallo/diffview-plus.nvim fork) applies the new diff
869+
refs to the existing diffview, otherwise (with
870870
https://github.com/sindrets/diffview.nvim) closes and re-opens the reviewer.
871871

872872
>lua

lua-test.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ PLUGINS_FOLDER="tests/plugins"
1010
PLUGINS=(
1111
"https://github.com/MunifTanjim/nui.nvim"
1212
"https://github.com/nvim-lua/plenary.nvim"
13-
"https://github.com/dlyongemallo/diffview.nvim"
13+
"https://github.com/dlyongemallo/diffview-plus.nvim"
1414
)
1515

1616
if ! command -v luarocks >/dev/null 2>&1; then

lua/gitlab/health.lua

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ M.check = function(return_results)
3131
package = "plenary",
3232
},
3333
{
34-
name = "dlyongemallo/diffview.nvim",
34+
name = "dlyongemallo/diffview-plus.nvim",
3535
package = "diffview",
3636
},
3737
}
@@ -45,6 +45,10 @@ M.check = function(return_results)
4545
name = "nvim-tree/nvim-web-devicons",
4646
package = "nvim-web-devicons",
4747
},
48+
{
49+
name = "dlyongemallo/diffview-plus.nvim",
50+
package = "diffview.api",
51+
},
4852
}
4953

5054
local go_version_problem = version.check_go_version()

0 commit comments

Comments
 (0)