https://github.com/aiken-lang/editor-integration-nvim
A plugin for working with Aiken on Vim / NeoVim.
https://github.com/aiken-lang/editor-integration-nvim
aiken neovim-plugin nvim-plugin vim-plugin
Last synced: about 2 months ago
JSON representation
A plugin for working with Aiken on Vim / NeoVim.
- Host: GitHub
- URL: https://github.com/aiken-lang/editor-integration-nvim
- Owner: aiken-lang
- License: mpl-2.0
- Created: 2022-11-10T10:16:58.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-12-05T10:44:46.000Z (5 months ago)
- Last Synced: 2025-12-08T19:42:59.446Z (5 months ago)
- Topics: aiken, neovim-plugin, nvim-plugin, vim-plugin
- Language: Vim Script
- Homepage:
- Size: 727 KB
- Stars: 14
- Watchers: 3
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Aiken Vim
A plugin for working with [Aiken](https://github.com/aiken-lang/aiken) on Vim / NeoVim.
## Features
- [x] Syntax Highlighting
- [x] Automatic indentation
- [x] Fold regions for `fn`, `test` and `bench`
- [x] LSP-integration via [coc.vim](https://github.com/neoclide/coc.nvim) or nvim's native LSP client.
## Installation
### Installation / [vim-plug](https://github.com/junegunn/vim-plug)
Simply use:
```vim
Plug 'aiken-lang/editor-integration-nvim'
```
#### (optional) Enabling folds
To enable fold regions, and in case your defaults are different from nvim's defaults, add the following:
```vim
autocmd FileType aiken setlocal foldenable foldlevelstart=0
```
To only fold when files are "long":
```vim
augroup AikenDynamicFolds
autocmd!
autocmd FileType aiken call s:AikenDynamicFoldSetup()
augroup END
function! s:AikenDynamicFoldSetup() abort
let nlines = line('$')
if nlines < 100
setlocal foldlevel=99
setlocal foldlevelstart=99
else
setlocal foldlevel=0
setlocal foldlevelstart=0
endif
endfunction
```
### Installation / [lazy.nvim](https://github.com/folke/lazy.nvim)
First add this to lazy.nvim setup:
```lua
{
"aiken-lang/editor-integration-nvim",
dependencies = {
'neovim/nvim-lspconfig',
}
}
```
Then to enable the Aiken LSP, add the following to `init.lua` file:
```lua
require'lspconfig'.aiken.setup({})
```
To enable the auto formatting on save, add the following to `init.lua` file:
```lua
vim.api.nvim_create_autocmd("BufWritePre", {
pattern = "*.ak",
callback = function()
vim.lsp.buf.format({async = false})
vim.opt_local.foldenable = true -- Optional, to enable or disable fold regions.
vim.opt_local.foldlevelstart = 0 -- Optional, start with all regions folded.
-- Or, to configure folding dynamically based on the file length
local buf = vim.api.nvim_get_current_buf()
local nlines = vim.api.nvim_buf_line_count(buf)
if nlines < 100 then
-- Small file: open all folds
vim.opt_local.foldlevel = 99
vim.opt_local.foldlevelstart = 99
else
-- Big file: start collapsed
vim.opt_local.foldlevel = 0
vim.opt_local.foldlevelstart = 0
end
end
})
```
### Installation / manual
Copy the content of `ftdetect`, `indent` and `syntax` to your `$HOME/.config/nvim/`.
Make sure that `:syntax` is `on`.
### LSP Configuration (coc.vim)
#### `:CocConfig`
```json
{ "languageserver":
{ "aiken":
{ "command": "aiken"
, "args": ["lsp"]
, "trace.server": "verbose"
, "rootPatterns": ["aiken.toml"]
, "filetypes": ["aiken"]
}
}
}
```
#### Automatic formatting
```vim
" Automatically format code on save
autocmd BufWritePre *.ak :silent! call CocAction('format')
```
### [Ctags](https://ctags.io/)
To use tags for navigation, use the following configuration:
```ctags
--langdef=Aiken
--langmap=Aiken:.ak
--regex-Aiken=/^fn[ \t]+([a-zA-Z0-9_]+)/\1/f,functions/
--regex-Aiken=/^test[ \t]+([a-zA-Z0-9_]+)/\1/f,functions/
--regex-Aiken=/^bench[ \t]+([a-zA-Z0-9_]+)/\1/f,functions/
--regex-Aiken=/^const[ \t]+([a-zA-Z0-9_]+)/\1/v,varlambdas/
--regex-Aiken=/^type[ \t]+([a-zA-Z0-9_]+)/\1/t,types/
```
## Preview
## License
[MPL-2.0](./LICENSE)