Skip to content

Commit

Permalink
plugins/cmp: add description to elevate autoEnableSource info
Browse files Browse the repository at this point in the history
  • Loading branch information
khaneliman committed Sep 1, 2024
1 parent b993182 commit 433673a
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions plugins/completion/cmp/default.nix
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,46 @@ helpers.neovim-plugin.mkNeovimPlugin config {

maintainers = [ maintainers.GaetanLepage ];

description = ''
### Completion Source Installation
If `plugins.cmp.autoEnableSources` is `true` Nixivm will automatically enable the corresponding source
plugins. This is the default behavior, but will work only when this option is set to a list.
If you use a raw lua string or set `plugins.cmp.autoEnableSources` to `false`, you will need to explicitly enable the relevant source plugins in
your nixvim configuration.
#### With auto-enabled sources
```nix
plugins.cmp = {
autoEnableSources = true;
settings.sources = [
{ name = "nvim_lsp"; }
{ name = "path"; }
{ name = "buffer"; }
];
};
```
#### Without auto-enabled sources
```nix
plugins = {
cmp = {
autoEnableSources = false;
settings.sources = [
{ name = "nvim_lsp"; }
{ name = "path"; }
{ name = "buffer"; }
];
};
cmp-nvim-lsp.enable = true;
cmp-path.enable = true;
cmp-buffer.enable = true;
};
```
'';

imports = [
# Introduced on 2024 February 21
# TODO: remove ~June 2024
Expand Down

0 comments on commit 433673a

Please sign in to comment.