Skip to content
This repository has been archived by the owner on Aug 7, 2023. It is now read-only.

Latest commit

 

History

History
41 lines (27 loc) · 1.46 KB

README.md

File metadata and controls

41 lines (27 loc) · 1.46 KB

linter-write-good

Naive linter for English prose for developers who can't write good and wanna learn to do other stuff good too.

A Linter interface for the write-good library.

This provides a variety of english usage text tips when writing documentation and commit messages.

This package requires Linter.

See it on atom.io

See it on github.com

Configuration

In the package settings, you can use a custom node binary, a custom write-good script, and pass arguments to the write good command. See write-good for possible arguments to the command.

Moreover, you can set the severity level of this linter. The default level is Error. Setting the severity level to Warning or Info helps distinguish write-good highlighting from the highlighting of an ordinary spell checker, or higher priority linters.

Note: Additional Linting

E-Prime

The Write-Good library implements a linter for E-Prime which is off by default. To enable E-Prime linting, you'll need to add the --yes-eprime flag to the extra arguments input under this package's settings page.