https://github.com/x1unix/gno.nvim
Gno integration for NeoVim
https://github.com/x1unix/gno.nvim
gnolang neovim neovim-plugin
Last synced: 3 months ago
JSON representation
Gno integration for NeoVim
- Host: GitHub
- URL: https://github.com/x1unix/gno.nvim
- Owner: x1unix
- License: mit
- Created: 2024-12-17T05:31:43.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-01-31T21:55:41.000Z (3 months ago)
- Last Synced: 2025-01-31T22:28:19.062Z (3 months ago)
- Topics: gnolang, neovim, neovim-plugin
- Language: Lua
- Homepage:
- Size: 2.24 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gno.nvim
Gno language support for NeoVim.
https://github.com/user-attachments/assets/08f5d0db-78db-465d-96e7-62fb381b31bb
## Features
* Syntax highlighting (uses Go treesitter config).
* Integration with gnopls using LSP.
* Automatic format on save.
* Support for [cmp-nvim-lsp](https://github.com/hrsh7th/cmp-nvim-lsp) (optional).
### Commands
* `:GnoDoc` - Show documentation for a package. Optional second argument is package name.
* `:GnoFmt` - Format current file.
* `:GnoRoot` - Print current gnoroot.
* `:GnoTest` - Run unit test.
* `:GnoTest` - Test current unit test file or package.
* `:GnoTest TestCaseName` - Test a specific test case.
## Prerequisites
### Command-Line Tools
* Gno Language Server:
* [gnoverse/gnopls](https://github.com/gnoverse/gnopls) - Based on gopls.
* [gnolang/gnopls](https://github.com/gnolang/gnopls/) - Unstable, not recommended.
### NeoVim Plugins
#### Required Plugins
* [nvim-lspconfig](https://github.com/neovim/nvim-lspconfig)
* [plenary.nvim](https://github.com/nvim-lua/plenary.nvim)
#### Recommended Plugins
* [cmp-nvim-lsp](https://github.com/hrsh7th/cmp-nvim-lsp) - Necessary to provide autocomplete from LSP server.
* [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter) - Treesitter grammars manager and configuration.
* [telescope-ui-select.nvim](https://github.com/nvim-telescope/telescope-ui-select.nvim) - For unit tests run selector dialog.
* [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) - Prerequisite for telescope-ui-select.nvim.
## Installation
> [!IMPORTANT]
> Ensure that `gnopls` language server is installed and available in `$PATH`.
### vim-plug
```vim
" Prerequisites
Plug 'neovim/nvim-lspconfig'
Plug 'nvim-lua/plenary.nvim'
" The plugin
Plug 'x1unix/gno.nvim'
```
### lazy.nvim
```lua
{
'x1unix/gno.nvim',
requires = { 'neovim/nvim-lspconfig', 'nvim-lua/plenary.nvim' },
config = function()
require('gno-nvim').setup()
end,
}
```
## Configuration
Here is a configuration example with defaults:
> [!NOTE]
> For LSP config, please check https://neovim.io/doc/user/lsp.html#vim.lsp.config()
```lua
require('gno-nvim').setup({
-- Custom GNOROOT path. Can be string or function.
--
-- Passed into Gno commands and LSP server environment variable.
--gnoroot = function()
-- return os.getenv("GNOROOT")
--end,
-- LSP client config
lsp = {
-- Path to gnopls server binary.
cmd = { 'gnopls', 'serve' },
-- Custom environment variables.
cmd_env = {
-- GNOROOT: 'custom env variable',
},
-- By default - integrate with nvim-cmp if installed.
capabilities = require('cmp_nvim_lsp').default_capabilities()
filetypes = { 'gno' },
-- ...
},
})
```
### Project-Specific GNOROOT
GNOROOT can be configured dynamically per-project.
> [!NOTE]
> GNOROOT for language server is set only once during LSP session startup.
Use `:GnoRoot` command to get current `GNOROOT`.
```lua
local utils = require("gno-nvim.utils")
local gno_fork_path = os.getenv("HOME") .. "/work/gno"
require('gno-nvim').setup({
gnoroot = function ()
local cwd = vim.fn.expand("%:p:h")
if cwd == "" then
cwd = vim.fn.getcwd()
end
-- If inside Gno work repo, use it as a GNOROOT.
if utils.has_prefix(cwd, gno_fork_path) then
return gno_fork_path
end
-- Use defaults
return nil
end,
})
```