https://github.com/errata-ai/write-good

A Vale-compatible implementation of the write-good linter.
https://github.com/errata-ai/write-good

vale vale-linter-style vale-style

Last synced: 19 days ago
JSON representation

A Vale-compatible implementation of the write-good linter.

• Host: GitHub
• URL: https://github.com/errata-ai/write-good
• Owner: errata-ai
• License: mit
• Created: 2019-05-29T22:07:01.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-11-21T05:48:35.000Z (about 1 year ago)
• Last Synced: 2024-12-29T01:31:58.730Z (12 months ago)
• Topics: vale, vale-linter-style, vale-style
• Language: Gherkin
• Homepage:
• Size: 37.1 KB
• Stars: 32
• Watchers: 3
• Forks: 7
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# write-good [![Build Status](https://travis-ci.org/errata-ai/write-good.svg?branch=master)](https://travis-ci.org/github/errata-ai/write-good) ![Vale version](https://img.shields.io/badge/vale-%3E%3D%20v1.7.0-blue.svg) ![license](https://img.shields.io/github/license/mashape/apistatus.svg)

> [`write-good`](https://github.com/btford/write-good): Naive linter for English prose for developers who can't write good and wanna learn to do other stuff good too.

This repository contains a [Vale-compatible](https://github.com/errata-ai/vale) implementation of the guidelines enforced by the `write-good` ([LICENSE](https://github.com/btford/write-good/blob/master/LICENSE)) linter.

## Getting Started

To get started, add the package to your configuration file (as shown below) and then run `vale sync`.

```ini

StylesPath = styles

MinAlertLevel = suggestion

Packages = write-good

[*]

BasedOnStyles = write-good

```