https://github.com/ck-zhang/mistake.nvim

a spelling auto correct plugin for Neovim including over 20k entries
https://github.com/ck-zhang/mistake.nvim

Last synced: 2 months ago
JSON representation

a spelling auto correct plugin for Neovim including over 20k entries

• Host: GitHub
• URL: https://github.com/ck-zhang/mistake.nvim
• Owner: ck-zhang
• License: mit
• Created: 2024-10-21T16:48:23.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-10-27T15:37:44.000Z (2 months ago)
• Last Synced: 2024-10-27T22:50:21.598Z (2 months ago)
• Language: Lua
• Homepage:
• Size: 348 KB
• Stars: 40
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• my-neovim-pluginlist - ck-zhang/mistake.nvim - zhang/mistake.nvim)   (Other Standard Feature Enhancement / Abbreviation)

README

        
# mistake.nvim

![Demo](https://github.com/user-attachments/assets/06167e5a-43cf-460b-b750-6fca75010f90)

**mistake.nvim** is a spelling auto correct plugin for Neovim based on [GitHub's *"Fixed typo"* commits](https://github.com/mhagiwara/github-typo-corpus). 

## Features

- Includes over 20,000 entries for correction 

- Lazy loads the correction dictionary in chunks with dynamic timing to reduce performance impact

- Supports adding personal corrections

## Installing (lazy.nvim)

```lua

{

  "https://github.com/ck-zhang/mistake.nvim",

}

```

## Adding Custom Corrections

To add your own corrections, edit the custom dictionary file:

```shell

nvim ~/.config/nvim/mistake_custom_dict.lua

```

## Feedback

Please create an issue for any faulty corrections you encounter, the entries are processed with NLTK to minimize faulty corrections, but I can't check them all.