Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/colinkennedy/spellbound.nvim
A spellcheck highlighter that suggests better words
https://github.com/colinkennedy/spellbound.nvim
Last synced: about 1 month ago
JSON representation
A spellcheck highlighter that suggests better words
- Host: GitHub
- URL: https://github.com/colinkennedy/spellbound.nvim
- Owner: ColinKennedy
- License: mit
- Created: 2024-05-14T04:06:05.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-06-12T03:29:43.000Z (7 months ago)
- Last Synced: 2024-10-12T22:54:03.558Z (2 months ago)
- Language: Lua
- Size: 71.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# spellbound.nvim
`spellbound.nvim` - Alternative word recommendations that you can control.
[](https://neovim.io)
[](https://www.lua.org)
[](https://github.com/ColinKennedy/spellbound.nvim/actions/workflows/stylua.yml)
[](https://github.com/ColinKennedy/spellbound.nvim/actions/workflows/luacheck.yml)
[](https://github.com/ColinKennedy/spellbound.nvim/actions/workflows/lua-typecheck.yml)
[](https://github.com/ColinKennedy/spellbound.nvim/actions/workflows/test.yml)
# Features
- Go to next / previous recommendation
- Show recommendations
- Native tree-sitter support
- Auto-rebuilds dictionary parts
- Note: Is compatible with [vim-spellsync](https://github.com/micarmst/vim-spellsync)
# Disclaimer
`spellbound.nvim` is both a plugin and a workflow. You might get decent results
using this plugin's default values but, for best performance, you should make
your own recommendations. You only get out of `spellbound.nvim` what you're
willing to put into it.
# Install
- [lazy.nvim](https://github.com/folke/lazy.nvim)
## Defaults
```lua
{
"ColinKennedy/spellbound.nvim",
cmd = {"Spellbound"},
config = ..., -- Add your personal configuration (See the Setup section)
keys = {
{
"[r",
"(SpellboundGoToPreviousRecommendation)",
desc = "Go to the previous recommendation.",
},
{
"]r",
"(SpellboundGoToNextRecommendation)",
desc = "Go to the next recommendation.",
},
}
}
```
## Lualine
```lua
local utils = require("lualine.utils.utils")
require("lualine").setup {
sections = {
lualine_y = {
{
"spellbound",
fallback_profile = { text = "none" },
profiles = {
my_profile = {
color = {
fg = utils.extract_color_from_hllist(
{ "fg", "sp" },
{ "Title" },
"#ffcc00"
),
},
},
},
}
}
}
}
```
# Setup
## Built-in Example
`spellbound.nvim` comes with a starting example configuration.
```lua
config = function()
require("spellbound").setup{
profiles = { my_profile = require("spellbound.profiles.example_me") }
}
end
```
To see what's in the profile, print its contents
```lua
print(vim.inspect(require("spellbound.profiles.example_me")))
```
You can use this to build your own configuration.
## Dynamic Example
This shows every feature at once. Most of the time you won't need all of this.
```lua
{
"ColinKennedy/spellbound.nvim",
cmd = {"Spellbound"},
config = function()
local dictionary = "en-strict"
require("spellbound").setup{
profiles = {
strict = {
dictionaries = {
name = dictionary,
input_paths = function()
local pattern = vim.fs.joinpath(
_CURRENT_DIRECTORY,
"spell",
"parts",
"*"
)
return vim.fn.glob(pattern, true, false)
end,
output_path = vim.fs.joinpath(
_CURRENT_DIRECTORY,
"spell",
dictionary .. ".dic"
),
},
spellfile = {
operation = "append",
text = function()
return "file:" .. vim.fs.joinpath(
_CURRENT_DIRECTORY,
"spell",
dictionary .. ".utf-8.add"
)
end,
},
spelllang = { operation = "replace", text = dictionary .. ",cjk" },
spellsuggest = {
operation = "replace",
text = function()
return "file:" .. vim.fs.joinpath(
_CURRENT_DIRECTORY,
"spell",
"strict_thesaurus.txt"
)
end,
},
},
},
}
end,
keys = {
{
"[r",
"(SpellboundGoToPreviousRecommendation)",
desc = "Go to the previous recommendation.",
},
{
"]r",
"(SpellboundGoToNextRecommendation)",
desc = "Go to the next recommendation.",
},
{
"tss",
":Spellbound toggle-profile strict",
desc = "[t]oggle all [s]trict [s]pelling mistakes.",
},
}
}
```
# Motivation
My coworkers who speak English as a second or even third language sometimes
find documentation hard to read.
To make my docstrings and documentation easier to understand, I added
a restriction - "You may only use 1000 unique words" and made myself a list.
Unfortunately, old habits die hard and sometimes I would forget my list or
fall back to words that are hard for non-native speakers to understand.
`spellbound.nvim` exists in order to:
- Help point out hard words and suggest easier words instead
- Jump to these suggested words easily
- View suggestions entire projects
A nice side effect of this plugin - if docstrings are easier for second/third
English speakers, chances are its even easier to read for native speakers too.
# Alternatives
If you don't create about highlighting text in the current file and just want
(Neo)vim to auto-correct your words as you type, you don't need `spellbound.nvim`.
Look up [:help Abbreviations](https://neovim.io/doc/user/usr_24.html#24.7)
instead.