mirror/nix-community.nixvim
1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2025-06-26 10:48:35 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

plugins/cmp: add description to elevate autoEnableSource info

Browse source
This commit is contained in:
Austin Horstman 2024-09-01 00:24:33 -05:00
parent b993182f15
commit 433673a7b8
No known key found for this signature in database
1 changed files with 40 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

40
plugins/completion/cmp/default.nix
View file

@ -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