cmp-go-deep

KO | EN

gitlite — search

#rust #kubernetes #claude #pytorch #ai #web #cross-platform #containers #framework #css

(★ 39)

A Go deep-completion source for unimported packages, for use with nvim-cmp/blink.cmp

File Explorer

ZIP Download

- - ci.yml
  - release.yml
- cmp_go_deep.txt
- tags
- - db.lua
  - gopls.lua
  - init.lua
  - treesitter.lua
  - utils.lua
- cmp_go_deep.lua
- completion_test.lua
- db_test.lua
- import_test.lua
- internal_test.lua
- minimal_init.lua
demo.gif
LICENSE
README.md

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

> [!IMPORTANT]
> `cmp-go-deep` is the predecessor to [`go-deep.nvim`](https://github.com/samiulsami/go-deep.nvim) and is no longer actively developed. New users should use `go-deep.nvim`.
>
> This version used a Lua + SQLite backend. I rewrote it because input/database updates could stutter, and standard-library indexing was too expensive to run cleanly inside the Neovim-side path. `go-deep.nvim` moves the backend to Go and handles concurrency, stdlib indexing, caching, and completion streaming more reliably.

A Go ```deep-completion``` source for [nvim-cmp](https://github.com/hrsh7th/nvim-cmp) / [blink.cmp](https://github.com/Saghen/blink.cmp), that works alongside [cmp-nvim-lsp](https://github.com/hrsh7th/cmp-nvim-lsp) / [blink.cmp](https://github.com/Saghen/blink.cmp)'s LSP source and provides completion suggestions for "UNIMPORTED LOCAL, INTERNAL, AND VENDORED PACKAGES ONLY".

#### Why?

At the time of writing, the Go Language Server (```gopls@v0.21.0```) doesn't seem to support deep completions for unimported packages. For example, with deep completion enabled, typing ```'cha'``` could suggest ```'rand.NewChaCha8()'``` as a possible completion option - but that is not the case no matter how high the completion budget is set for ```gopls```.

#### How?

Query  ```gopls's``` ```workspace/symbol``` endpoint, cache the results using ```sqlite```, convert the resulting ```SymbolInformation``` into ```completionItemKinds```, filter the results to only include the ones that are unimported, then finally feed them back into ```nvim-cmp``` / ```blink.cmp```

---
⚠️ it might take a while for the packages to be indexed by gopls in huge codebases 
#### Demo

* Note: Due to how gopls indexes packages, completions for standard library packages are not available until at least one of them is manually imported.

 <img src="./demo.gif" alt="demo" />

---
## Requirements
- [nvim-cmp](https://github.com/hrsh7th/nvim-cmp) OR [blink.cmp](https://github.com/saghen/blink.cmp)
- [sqlite.lua](https://github.com/kkharji/sqlite.lua)

## Setup
#### Lazy.nvim
##### - nvim-cmp
```lua
{
	"hrsh7th/nvim-cmp",
	dependencies = {
		{ "samiulsami/cmp-go-deep", dependencies = { "kkharji/sqlite.lua" } },
	},
	...
	require("cmp").setup({
		sources = {{
			name = "go_deep",
			keyword_length = 3,
			max_item_count = 5,
			---@module "cmp_go_deep"
			---@type cmp_go_deep.Options
			option = {
				-- See below for configuration options
			},
		}},
	})
}
```
##### - blink.cmp (requires saghen/blink.compat)
```lua
{
	"saghen/blink.cmp",
	dependencies = {
		{ "samiulsami/cmp-go-deep", dependencies = { "kkharji/sqlite.lua" } },
		{ "saghen/blink.compat" },
	},
	opts = {
		sources = {
			default = {
				"go_deep",
			},
			providers = {
				go_deep = {
					name = "go_deep",
					module = "blink.compat.source",
					min_keyword_length = 3,
					max_items = 5,
					---@module "cmp_go_deep"
					---@type cmp_go_deep.Options
					opts = {
						-- See below for configuration options
					},
				},
			},
		},
	},
}
```
### Default options
```lua
{
	-- Enable/disable notifications.
	notifications = true,

-- Filetypes to enable the source for.
	filetypes = { "go" },

-- How to get documentation for Go symbols.
	-- options:
	-- "hover" - LSP 'textDocument/hover'. Prettier.
	-- "regex" - faster and simpler.
	get_documentation_implementation = "regex",

-- How to get the package names.
	-- options:
	-- "treesitter" - accurate but slower.
	-- "regex" - faster but can fail in edge cases.
	get_package_name_implementation = "regex",

-- Whether to exclude vendored packages from completions.
	exclude_vendored_packages = false,

-- Whether to exclude internal packages that cannot be imported.
	-- Follows Go's internal package rule: code can only import from "internal"
	-- if it's in a subtree rooted at the parent of "internal".
	exclude_internal_packages = true,

-- Timeout in milliseconds for fetching documentation.
	-- Controls how long to wait for documentation to load.
	documentation_wait_timeout_ms = 100,

-- Maximum time (in milliseconds) to wait before "locking-in" the current request and sending it to gopls.
	debounce_gopls_requests_ms = 0

-- Path to store the SQLite database
	-- Default: "~/.local/share/nvim/cmp_go_deep.sqlite3"
	db_path = vim.fn.stdpath("data") .. "/cmp_go_deep.sqlite3",
}
```
---
#### TODO
- [x] Cache results for faster completions.
- [x] Cross-project cache sharing for internal packages.
- [x] Better memory usage.
- [x] Don't ignore package names while matching symbols.
- [ ] Archive after [this issue](https://github.com/golang/go/issues/38528) is properly addressed.

cmp-go-deep

Owner Repos

File Explorer

# Use via CDN

Was this content helpful?

Recent Feedback

cmp-go-deep

Owner Repos

File Explorer

# Use via CDN

Was this content helpful?

Recent Feedback

Download README