Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/PaysanCorrezien/dictionary.nvim
https://github.com/PaysanCorrezien/dictionary.nvim
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/PaysanCorrezien/dictionary.nvim
- Owner: PaysanCorrezien
- License: mit
- Created: 2023-12-23T17:39:35.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-09T15:09:49.000Z (12 months ago)
- Last Synced: 2024-08-02T18:37:13.741Z (5 months ago)
- Language: Lua
- Size: 20.5 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- my-neovim-pluginlist - PaysanCorrezien/dictionary.nvim - commit/PaysanCorrezien/dictionary.nvim)  (Other Standard Feature Enhancement / Dictionary)
README
# dictionary.nvim -- Dictionary Manager for Neovim
🚧 WIP -- Not stable
Dictionary Manager is a Neovim plugin designed to enhance the spell checking and dictionary management experience. It integrates with `nvim-cmp` for spell suggestions and manages custom dictionaries for different languages, along with LTEX language server support.
## Features
- Manage multiple custom dictionaries.
- Spell suggestions with `nvim-cmp` integration.
- LTEX language server support for extended functionality.
- Easy addition and update of words in dictionaries.
- Configurable for various file types and use-cases.
_It should work on both windows and WSL_
## Prerequisites
- Neovim (0.9 or newer) , not tested in older version
- `nvim-cmp` plugin (for spell suggestions)
- LTEX language server (optional, for enhanced language support)
- ltex-extra.nvim
## 🪄 Installation
Install using your preferred Neovim package manager. For example, with `Lazy.nvim`:
```lua
"paysancorrezien/dictionary.nvim"
ft = "markdown",
dependencies = {
"nvim-lua/plenary.nvim",
},
config = function()
require("dictionary").setup({
dictionary_paths = {
home .. "/.config/nvim/dict/ltex.dictionary.fr.txt",
home .. "/.config/nvim/dict/spell.utf-8.add",
},
override_zg = true,
ltex_dictionary = true, -- if you are use ltex-ls extra and want to use zg to also update ltex-ls dictionary
cmp = {
enabled = true,
custom_dict_path = local_ltex_ls,
max_spell_suggestions = 10,
filetypes = { "markdown", "tex" },
priority = 20000,
name = "mydictionary",
source_label = "[Dict]",
kind_icon = "ï€ "
},
})
end,
},
}
```
## 📖 Commands
```vim
:DictionaryAddWord - Add the current word to the spell and sync dictionaries.
:DictionaryConfigPrint - Print the current configuration.
:DictionaryUpdate - Update the custom dictionary.
:DictionaryPickLang - Pick a language and update LTEX-LS configuration
:DictionnaryUpdateLang fr - Update LTEX-LS configuration with the language `fr` or any others from [LTEX-ls](https://valentjn.github.io/ltex/supported-languages.html)
```
## Usage
To add a new word to your dictionaries, use the :DictionaryAddWord command while your cursor is over the word.
`:DictionaryUpdate` Open a new buffer with all merged dict, to edit them and sync
## 🎹 Example keymap configuration
I put all my note-taking binding's user `z` thanks to zettelkasten plugin,
so I use those :
```lua
vim.keymap.set("n", "zg", "DictionaryAddWord ", { desc = "Add word to dict" }) -- Add the current word to dictionary, if override_zg = true it does the same without leader
vim.keymap.set("n", "zL", "DictionaryPickLang", { desc = "Change LSP Lang" })
vim.keymap.set("n", "gU", "DictionaryUpdate ", { desc = "Edit Dicts" })
vim.keymap.set("n", "zF", "DictionaryUpdateLspLang fr", { desc = "Correct French" })
vim.keymap.set("n", "zE", "DictionaryUpdateLspLang en", { desc = "Correct English" })
```
## License
This project is licensed under MIT License.