Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pasibergman/cmp-nuget
Neovim plugin for NuGet package and version completion with nvim-cmp.
https://github.com/pasibergman/cmp-nuget
autocomplete autocompletion csharp dotnet dotnet-core lua lunarvim neovim neovim-plugin nuget nuget-package nvim-cmp
Last synced: 3 months ago
JSON representation
Neovim plugin for NuGet package and version completion with nvim-cmp.
- Host: GitHub
- URL: https://github.com/pasibergman/cmp-nuget
- Owner: PasiBergman
- License: mit
- Created: 2022-01-09T17:11:57.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-07T21:00:14.000Z (7 months ago)
- Last Synced: 2024-07-07T22:21:20.820Z (7 months ago)
- Topics: autocomplete, autocompletion, csharp, dotnet, dotnet-core, lua, lunarvim, neovim, neovim-plugin, nuget, nuget-package, nvim-cmp
- Language: Lua
- Homepage:
- Size: 5.02 MB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NuGet completion for nvim-cmp
Completion source for [nvim-cmp](https://github.com/hrsh7th/nvim-cmp) helping to
autocomplete NuGet packages and versions on .csproj files.
## Requirements
- [Neovim](https://gitub.com/neovim/neovim)
- [nvim-cmp](https://github.com/hrsh7th/nvim-cmp) plugin
- [plenary](https://github.com/nvim-lua/plenary.nvim) plugin
- [curl](https://curl.se)
## Installation
### LazyVim
In a cmp configuration file, e.g. `~/.config/nvim/lua/plugins/cmp-nuget.lua` add the following configuration:
```lua
return {
{
"nvim-cmp",
dependencies = {
"PasiBergman/cmp-nuget",
},
opts = function(_, opts)
local nuget = require("cmp-nuget")
nuget.setup({})
table.insert(opts.sources, 1, {
name = "nuget",
})
opts.formatting.format = function(entry, vim_item)
if entry.source.name == "nuget" then
vim_item.kind = "NuGet"
end
return vim_item
end
end,
},
}
```
### LunarVim
In your [LunarVim](https://lunarvim.org) cofiguration file:
```lua
lvim.plugins = {
...
{
"PasiBergman/cmp-nuget",
event = "BufWinEnter",
config = function()
local cmp_nuget = require("cmp-nuget")
cmp_nuget.setup({})
-- Insert 'nuget' source before 'buffer'
table.insert(lvim.builtin.cmp.sources, 6, {
name = "nuget",
keyword_length = 0,
})
lvim.builtin.cmp.formatting.source_names["nuget"] = "(NuGet)"
end,
},
...
}
```
Remember to `:PackerSync` after changes to plugins.
### Neovim
For [packer](https://github.com/wbthomason/packer.nvim):
```lua
use {
'PasiBergman/cmp-nuget',
requires = {
'nvim-lua/plenary.nvim'
},
}
```
For [vim-plug](https://github.com/junegunn/vim-plug):
```lua
Plug 'nvim-lua/plenary.nvim'
Plug 'PasiBergman/cmp-nuget'
```
Run the `setup` function and add the source
```lua
require('cmp-nuget').setup({})
require('cmp').setup({
...,
sources = {
{
name = "nuget",
keyword_length = 0,
},
...
},
formatting = {
source_names = {
nuget = "(NuGet)",
},
},
})
```
## Configuration
The `require("cmp-nuget").setup()` function accepts an config override table.
**Default** configuration:
```lua
{
filetypes = {}, -- on which filetypes cmp-nuget is active
file_extensions = { "csproj" }, -- on which file extensions cmp-nuget is active
nuget = {
packages = { -- configuration for searching packages
limit = 100, -- limit package serach to first 100 packages
prerelease = false, -- include prerelase (preview, rc, etc.) packages
sem_ver_level = "2.0.0", -- semantic version level (*
package_type = "", -- package type to use to filter packages (*
},
versions = {
prerelease = true, -- include prerelase (preview, rc, etc.) versions
sem_ver_level = "2.0.0", -- semantic version level (*
},
},
}
```
(\* more information:
- [SemVer2 support for fuget.org](https://github.com/NuGet/Home/wiki/SemVer2-support-for-nuget.org-%28server-side%29)
- [Package Type](https://github.com/NuGet/Home/wiki/Package-Type-%5BPacking%5D)
Example of overriding default configuration during setup.
```lua
require('cmp-nuget').setup({
nuget = {
packages = {
limit = 20,
prerelease = true,
},
},
})
```
## Known bugs and limitations
Requires the `PackageReference` with `Include=` and `Version=` to be on single line.
Does not parse the `xml` content.