doc, config for nvim.difftool (built-in to neovim) as a diff-editor merge-tool - #10207
DirectXMan12 wants to merge 1 commit into
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
There was a problem hiding this comment.
The following commits do not follow our format for subject lines:
- 19a75da: [docs] nvim 0.12.0 nvim.difftool instructions are in the wiki
- 0f7d0d0: ship a config for nvim 0.12.0's difftool as a merge-tool
Commits should have a subject line following the format <topic>: <description>. Please review the commit guidelines for more information.
0f7d0d0 to
5acd655
Compare
All commits are now correctly formatted. Thank you for your contribution!
josephlou5
left a comment
There was a problem hiding this comment.
Please fix tests. Looks like test_completion::test_merge_tools is failing.
5acd655 to
caf3670
Compare
caf3670 to
7fc18ba
Compare
|
ok, tests fixed, reworded description slightly to clarify that this is a diff-edit merge-tool, and not a 3-way-diff merge-tool 1. in theory we could add a unified "neovim" or "nvim" entry that was Footnotes
|
actually, now that i think about this more, i think this probably feels like a nicer experience for users. just being able to do lemme test that real quick and i'll push the changes |
7fc18ba to
b4315a2
Compare
|
ok, ci looks green on those new changes, should be good for another review round |
| diff-args=["--diff", "$left", "$right", "--wait"] | ||
| diff-invocation-mode="file-by-file" | ||
| edit-args = [] | ||
|
|
There was a problem hiding this comment.
I think I'd personally prefer a commit that adds the tool directly instead of just in the documentation (so your second commit), but I'm not a maintainer so just providing my opinion (no changes needed).
(I also don't use Neovim, so this is just from the perspective of "if we can make it easier for users, might as well make it easier for users" ¯\⎽(ツ)⎽/¯)
There was a problem hiding this comment.
(Also, I won't give approval (but again, not a maintainer) because for now there are 2 commits doing different things, so this PR can't be merged as-is.)
There was a problem hiding this comment.
cool, I'm happy to drop the first commit if others feel the same way, figured I'd just offer the option
There was a problem hiding this comment.
(I personally prefer the second commit too, so seems good to me, but I'll wait for a maintainer to weight in)
There was a problem hiding this comment.
nit: I think all of this can be a single commit.
nvim 0.12.0 adds support for using its built-in plugin `nvim.difftool` to do dirdiffs. this works quite nicely with jj, so add a built-in config for it and document that in the docs so that folks can see it. this removes the link to the wiki (introduced in the previous commit) since the config is now built-in.
b4315a2 to
7fd177a
Compare
this notes/adds built-in config for the new(ish) builtin neovim support for dirdiffs, which makes neovim a relatively nice jj merge tool (nicer than vimdiff, easier to set up than the mentioned plugins since it ships in neovim ootb).
i've added 2 commits here -- a minimal "here's a link to the wiki" and a more maximal "here's an entry in the built-in config + a note in the docs". wasn't sure which was more preferable.
Checklist
If applicable:
CHANGELOG.mdREADME.md,docs/,demos/)cli/src/config-schema.json) (n/a)how it works, how it's organized), including any code drafted by an LLM.
an eye towards deleting anything that is irrelevant, clarifying anything
that is confusing, and adding details that are relevant. This includes,
for example, commit descriptions, PR descriptions, and code comments.
(n/a, this comes 100% from wetware ;-))