akinsho / spellsitter.nvim

Treesitter powered spellchecker

spellsitter.nvim

Spell checker for Neovim powered by tree-sitter.

Status

WIP

This plugin relies on Neovim's tree-sitter API which is still under development. Expect things to break sometimes but please don't hesitate to raise an issue.

Requirements

Neovim >= 0.5.0

Installation

packer.nvim:

use {
  -- Optional but recommended
  -- 'nvim-treesitter/nvim-treesitter',
  'lewis6991/spellsitter.nvim',
}

vim-plug:

" Optional but recommended
" Plug 'nvim-treesitter/nvim-treesitter'
Plug 'lewis6991/spellsitter.nvim'

Note: This plugin does not depend on nvim-treesitter however it is recommended in order to easily install tree-sitter parsers.

Usage

For basic setup with all batteries included:

require('spellsitter').setup()

If using packer.nvim spellsitter can be setup directly in the plugin spec:

use {
  'lewis6991/spellsitter.nvim',
  config = function()
    require('spellsitter').setup()
  end
}

Configuration can be passed to the setup function. Here is an example with all the default settings:

require('spellsitter').setup {
  hl = 'SpellBad',
  captures = {'comment'},  -- set to {} to spellcheck everything
}