1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111# cmp-dotenv
https://github.com/SergioRibera/cmp-dotenv/assets/56278796/8a23c17a-6f08-45db-b567-de47cd9a8a81
| Wihtout cmp-dotenv | With cmp-dotenv |
|----------------------|-----------------|
|  |  |
The plugin you need to have an autocomplete of the environment variables of your system
and those of your `.env*` files
> [!IMPORTANT]
> This repository does not require constant updates but if you have any problems or feature suggestions open an [issue](https://github.com/SergioRibera/cmp-dotenv/issues) and I will be happy to check it out.
## Setup
```lua
require("cmp").setup {
sources = {
{ name = "dotenv" }
}
}
```
Or with configuration
```lua
local cmp = require("cmp")
cmp.setup {
sources = {
{
name = "dotenv",
-- Defaults
option = {
path = '.',
load_shell = true,
item_kind = cmp.lsp.CompletionItemKind.Variable,
eval_on_confirm = false,
show_documentation = true,
show_content_on_docs = true,
documentation_kind = 'markdown',
dotenv_environment = '.*',
file_priority = function(a, b)
-- Prioritizing local files
return a:upper() < b:upper()
end,
}
}
}
}
```
## Options
| name | default | description |
|----------------------|--------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| path | '.' | The path where to look for the files |
| load_shell | true | Do you want to load shell variables? |
| item_kind | [Variable](https://github.com/hrsh7th/nvim-cmp/blob/main/lua/cmp/types/lsp.lua#L178) | What kind of suggestion will cmp make? |
| eval_on_confirm | false | When you confirm the completion, do you want the variable or the value? |
| show_documentation | true | Do you want to see the documentation that has the variable? |
| show_content_on_docs | true | Allows to preview the content in the documentation popup with the prefix of `Content: `. |
| documentation_kind | 'markdown' | What did you write the variable documentation on? |
| dotenv_environment | '.*' | Which variable environment do you want to load? `.*` by default loads all of them, this variable accepts regex, some suggestions I can give you are `example`, `local` or `development`. |
| file_priority | function | With this function you define the upload priority, by default it prioritizes the local variables, this responds to the callback of a computer for the found files. |
## Advanced Usage
If you are a developer or just want to do more things in your lua configuration,
you can use the api provided here and the (recommended) functions available, are these
```lua
local dotenv = require('cmp-dotenv.dotenv')
-- Get the variable you want by name or
-- get the default value in case it does not exist.
dotenv.get_env_variable(name, default)
-- Get all variables that have been loaded
dotenv.get_all_env()
-- You can set a variable to the auto-completion system and
-- find it available throughout the Neovim environment.
-- You can pass it a documentation in the format
-- you have configured or not pass it at all.
dotenv.set_env_variable(name, value, docs or nil)
-- This loads all the environment variables according to the
-- configuration you have from the files or the shell,
-- I do not recommend calling this function as it is
-- usually called by default by cmp.
dotenv.load(force, options)
```
## Contributing
All contributions are welcome!
See [CONTRIBUTING.md](./CONTRIBUTING.md).
## License
This template is [licensed according to GPL version 2](./LICENSE),
with the following exception:
The license applies only to the Nix CI infrastructure provided by this template
repository, including any modifications made to the infrastructure.
Any software that uses or is derived from this template may be licensed under any
[OSI approved open source license](https://opensource.org/licenses/),
without being subject to the GPL version 2 license of this template.