https://github.com/chrisletter/cspell-ignore
A Neovim plugin to quickly add words to the cspell dictionary
https://github.com/chrisletter/cspell-ignore
cspell neovim neovim-plugin nvim
Last synced: 8 months ago
JSON representation
A Neovim plugin to quickly add words to the cspell dictionary
- Host: GitHub
- URL: https://github.com/chrisletter/cspell-ignore
- Owner: ChrisLetter
- Created: 2024-08-22T17:29:33.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-26T13:29:59.000Z (about 1 year ago)
- Last Synced: 2025-03-06T04:15:15.685Z (8 months ago)
- Topics: cspell, neovim, neovim-plugin, nvim
- Language: JavaScript
- Homepage:
- Size: 5.86 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Cspell Ignore
This plugin provides a quick way to add words to the cspell ignore list. This is useful when you are using a linter that doesn't support code actions (like `nvim-lint`) and you don't want your editor to be bloated with cspell errors.
## Requirements
- nodejs > 20 installed on your machine
## Installation and configuration
Example of installation using lazy.nvim
```lua
{
'ChrisLetter/cspell-ignore',
event = { 'VeryLazy' },
config = function()
require('cspell-ignore').setup { cspell_path = '~/cspell.json' }
vim.keymap.set({ 'n', 'v' }, 'ci', require('cspell-ignore').ignore, { desc = '[C]spell [I]gnore' })
end,
},
```
In the setup function, you need to pass the path to the cspell configuration file (only the JSON variant is supported at the moment).
## Usage
The plugin will add the word under the cursor to the cspell ignore list. You can use the `:CspellIgnore` command, or you can define a keymap as shown in the example above.