Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/superDross/spellbound.nvim
Spelling configurations and mapping for neovim
https://github.com/superDross/spellbound.nvim
Last synced: 4 months ago
JSON representation
Spelling configurations and mapping for neovim
- Host: GitHub
- URL: https://github.com/superDross/spellbound.nvim
- Owner: superDross
- License: gpl-3.0
- Created: 2022-09-18T17:41:54.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-12T06:54:33.000Z (about 1 year ago)
- Last Synced: 2024-05-05T15:34:11.363Z (7 months ago)
- Language: Lua
- Size: 33.2 KB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SpellBound.nvim :sparkles:
Spelling commands and mappings for Neovim.
## Features
- Automatically turn on spelling for certain file types
- Add mapping and command for toggling spelling on/off
- Add mappings for fixing spelling relative to the cursor in both normal and insert mode
## Installation and Requirements
Requires Neovim 0.7+
Ensure a dictionary is set in your `init.lua` file:
```lua
vim.o.dictionary = '/usr/share/dict/cracklib-small'
```
The easiest way to get the above file within your filesystem is to download the [Cracktime-Runtime](https://ubuntu.pkgs.org/20.04/ubuntu-main-arm64/cracklib-runtime_2.9.6-3.2_arm64.deb.html) package.
With [Packer.nvim](https://github.com/wbthomason/packer.nvim):
```lua
require('packer').startup(function(use)
use 'superDross/spellbound.nvim'
end)
```
## Commands
- `:SpellingToggle` -- toggle spelling on/off
## Configuration & Mappings
- `mapping.toggle_map` -- mapping for toggling spelling on/off (default: `Ctrl-S`)
- `mapping.fix_right` -- fix the nearest spelling mistake to the right of the cursor with the first suggestion (default: `Ctrl-l`)
- `mapping.fix_left` -- fix the nearest spelling mistake to the left of the cursor with the first suggestion (default: `Ctrl-h`)
- `language` -- language to check spelling against
- `autospell_filetypes` -- filetypes that should have spelling activated when opened
- `autospell_gitfiles` -- activate spelling for git commit and rebase buffers
- `number_suggestions` -- number of suggestions to display with `z=`
- `return_to_position` -- return to the original cursor position after executing `fix_right`/`fix_left` mapping
- `highlight.bg_colour` -- background colour of the highlight (default: `lightgreen`)
- `highlight.fg_colour` -- foreground colour of the highlight (default: `black`)
- `highlight.timer` -- number of microseconds in which the highlight will flash for (default: 500)
### Defaults
```lua
-- default settings
vim.g.spellbound_settings = {
mappings = {
toggle_map = '',
fix_right = '',
fix_left = '',
},
language = 'en_gb',
autospell_filetypes = { '*.txt', '*.md', '*.rst' },
autospell_gitfiles = true,
number_suggestions = 10,
return_to_position = false,
}
```
### Custom Configuration
To change the language to Spanish and toggle map key, but keep the fix maps defaults, then add the following to your `init.lua`:
```lua
vim.g.spellbound_settings = {
mappings = {
toggle_map = 's'
},
language = 'es',
}
```