Home

Awesome

vim-textidote

Description

This plugin interfaces Vim and Neovim with the TeXtidote grammar checker. TeXtidote is an open source spelling, grammar and style checker for multiple languages based on LanguageTool. TeXtidote is built on top of LanguageTool and is able to remove LaTeX and Markdown markup before grammar checking, while keeping track of the relative position of words between the original and "clean text". In short, TeXtidote is a version of LanguageTool made blind to LaTeX and Markdown markup.

This plugin provides asynchronous integration of both TeXtidote and LanguageTool, with highlighting of the spelling and grammar errors. It offers also easy and intuitive navigation of the errors, as well as quick fixes by <Tab> completion.

Screenshots

Example in Vim: Vim

Html report in browser: Html

Installation

Install vim-textidote using your favorite package manager, or use Vim's built-in package support:

mkdir -p ~/.vim/pack/PatrBal/start
cd ~/.vim/pack/PatrBal/start
git clone https://github.com/PatrBal/vim-textidote
vim -u NONE -c "helptags vim-textidote/doc" -c q

Download the latest textidote.jar from TeXtidote and make sure that you have Java version 8 or later installed on your system. Specify the location of the file textidote.jar in your $HOME/.vimrc file. Example:

let g:textidote_jar = '~/.vim/textidote.jar'

Usage

:[range]TeXtidoteToggle
By default [range] is the whole buffer, except in the case where there is a visual selection which is then taken as the default [range].

Features

Alternatives

License

Copyright © Patrick Ballard. Distributed under the same terms as Vim itself. See :help license.

Credit

This plugin is strongly based on the excellent vim-LanguageTool. Large parts of its code have been reused.