Skip to content

docs: simplify coexistence section #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wassimk merged 1 commit into from
Mar 15, 2026
Merged

docs: simplify coexistence section #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,12 +117,14 @@ nvim-cmp users can pass the same options to `require('git-coauthors').setup()`.

## 🤝 Coexisting with Other `@` Sources

If you also use
[blink-cmp-git](https://github.com/Kaiser-Yang/blink-cmp-git) for GitHub `@`
mentions, use `is_coauthor_context()` with blink.cmp's `transform_items` to
suppress its results on `Co-Authored-By:` lines:
If another completion source also triggers on `@` (e.g.,
[blink-cmp-git](https://github.com/Kaiser-Yang/blink-cmp-git) for GitHub
mentions), both will fire on `Co-Authored-By:` lines.
`is_coauthor_context()` returns `true` when the cursor is on a
`Co-Authored-By:` line so you can conditionally suppress the other source:

```lua
-- blink.cmp + blink-cmp-git
git = {
name = 'Git',
module = 'blink-cmp-git',
Expand All @@ -133,10 +135,13 @@ git = {
return items
end,
},
```

Note: blink-cmp-git's per-feature `enable` option is evaluated at cache time,
not per-keystroke, so `transform_items` is the correct approach here.
-- nvim-cmp + cmp-git
{ name = 'git', entry_filter = function(entry, ctx)
return not require('git-coauthors').is_coauthor_context()
end,
},
```

## 🔨 Development

Expand Down
18 changes: 12 additions & 6 deletions doc/git-coauthors.nvim.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,11 +152,14 @@ nvim-cmp users can pass the same options to `require('git-coauthors').setup()`.

П�� COEXISTING WITH OTHER @ SOURCES*git-coauthors.nvim-git-coauthors.nvim-🤝-coexisting-with-other-@-sources*

If you also use blink-cmp-git <https://github.com/Kaiser-Yang/blink-cmp-git>
for GitHub `@` mentions, use `is_coauthor_context()` with blink.cmp’s
`transform_items` to suppress its results on `Co-Authored-By:` lines:
If another completion source also triggers on `@` (e.g., blink-cmp-git
<https://github.com/Kaiser-Yang/blink-cmp-git> for GitHub mentions), both will
fire on `Co-Authored-By:` lines. `is_coauthor_context()` returns `true` when
the cursor is on a `Co-Authored-By:` line so you can conditionally suppress the
other source:

>lua
-- blink.cmp + blink-cmp-git
git = {
name = 'Git',
module = 'blink-cmp-git',
Expand All @@ -167,11 +170,14 @@ for GitHub `@` mentions, use `is_coauthor_context()` with blink.cmp’s
return items
end,
},

-- nvim-cmp + cmp-git
{ name = 'git', entry_filter = function(entry, ctx)
return not require('git-coauthors').is_coauthor_context()
end,
},
<

Note: blink-cmp-git’s per-feature `enable` option is evaluated at cache time,
not per-keystroke, so `transform_items` is the correct approach here.


П�� DEVELOPMENT *git-coauthors.nvim-git-coauthors.nvim-🔨-development*

Expand Down
Loading