https://github.com/ubaldot/vim-writegood

Check your English prose in Vim.
https://github.com/ubaldot/vim-writegood

linting prose vim9

Last synced: about 2 months ago
JSON representation

Check your English prose in Vim.

• Host: GitHub
• URL: https://github.com/ubaldot/vim-writegood
• Owner: ubaldot
• License: bsd-3-clause
• Created: 2023-05-20T20:18:41.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-05-31T07:53:44.000Z (over 1 year ago)
• Last Synced: 2024-10-27T13:10:18.163Z (3 months ago)
• Topics: linting, prose, vim9
• Language: Vim Script
• Homepage: https://www.vim.org/scripts/script.php?script_id=6073
• Size: 1.04 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-vim9 - vim-writegood

README

        
# vim-writegood

Check your English prose in Vim.







## Introduction

Vim-writegood check your English prose.


It is nothing but a simple Vim9 wrapper around prose linters.

## Requirements

You must have a prose linter installed. Currently supported linters are

[write-good](https://github.com/btford/write-good) and

[vale](https://vale.sh).  Check their docs for installation and configuration

guidelines.

Oh, and you need Vim9 of course.

## Usage

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 `:WriteGoodToggle` once or twice, that's all.

## Configuration

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`.

## Contributing

Feel free to send a PR if have any improvement ideas.

## License

BSD3-Clause.