https://github.com/norseghost/nvimwordlist
Create a spell file for Neovim builtins
https://github.com/norseghost/nvimwordlist
neovim neovim-lua neovim-lua-plugin neovim-plugin spellcheck spellchecker spelling
Last synced: 3 months ago
JSON representation
Create a spell file for Neovim builtins
- Host: GitHub
- URL: https://github.com/norseghost/nvimwordlist
- Owner: norseghost
- Created: 2022-10-25T22:06:46.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-11-03T03:57:55.000Z (almost 3 years ago)
- Last Synced: 2024-08-07T18:35:39.108Z (about 1 year ago)
- Topics: neovim, neovim-lua, neovim-lua-plugin, neovim-plugin, spellcheck, spellchecker, spelling
- Language: Lua
- Homepage:
- Size: 9.77 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# nvimwordlist
Neovim spell checking is great; more so with it being treesitter aware.
However, doing Neovim configuration, there can be a lot of commands and options in strings that get flagged as bad words.
This plugin tries to alleviate that.
## Installation
Using Packer:
```lua
use {
"norseghost/nvimwordlist",
run = "NvimWordlistUpdate",
config = function()
vim.opt.spelllang:append("vim")
end
}
```
## How it works
Generates a vim spelling file for vim commands and options; to aid in plugin development and configuration.
The word list is made from (ab)using the `vim.fn.getcompletions()` function, and will thus find commands from plugins as well as the Neovim builtin.
## To Do
- [x] short option names
- [x] option values
- [ ] configurable subsets for the list
- [ ] automatically set up spelllang for `.lua`, `.vim`, `.md` filetypes?
- [ ] (eventually) vim documentation