Check your English prose in Vim.
Vim-writegood check your English prose.
It is nothing but a simple Vim9 wrapper around prose linters.
You must have a prose linter installed. Currently supported linters are write-good and vale. Check their docs for installation and configuration guidelines.
Oh, and you need Vim9 of course.
Vim-writegood has only one command:
:WriteGoodToggle
which is used to turn on and off the linter.
The diagnostic messages are stored in the quickfix list and displayed in the
command-line.
You can use all the quickfix list features such as :cnext, :cprev, :copen, etc. to conveniently move around.
See :h quickfix for more info.
The quickfix list automatically updates "on save", i.e. you must save your file to refresh the linting otherwise you won't see your problems to disappear.
Warning
When you change (or come back to a previous) buffer, you have to manually re-enable the linting. Don't be fooled if the highlight is still on! To fix it, run
:WriteGoodToggleonce or twice, that's all.
There are few parameters that you can tweak:
# Default values
g:writegood_compiler = "writegood" # Can be "writegood" or "vale".
g:writegood_options = "" # CLI options to append to write-good call
g:writegood_linehl = "CursorLine"
g:writegood_text = "--"
g:writegood_texthl = ""
To figure out the meaning of the latter three parameters, check :h sign_define() and to figure out possible values type :highlight.
Feel free to send a PR if have any improvement ideas.
BSD3-Clause.