https://github.com/sapegin/proselint

Proselint wrapper with a friendly reporter
https://github.com/sapegin/proselint

linter markdown prose text

Last synced: 18 days ago
JSON representation

Proselint wrapper with a friendly reporter

• Host: GitHub
• URL: https://github.com/sapegin/proselint
• Owner: sapegin
• License: mit
• Created: 2017-02-05T17:20:42.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-02-28T14:48:25.000Z (over 1 year ago)
• Last Synced: 2024-08-10T17:08:14.467Z (3 months ago)
• Topics: linter, markdown, prose, text
• Language: JavaScript
• Size: 401 KB
• Stars: 60
• Watchers: 4
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: Readme.md
  • Contributing: Contributing.md
  • License: License.md

Awesome Lists containing this project

README

        
# proselint

[![npm](https://img.shields.io/npm/v/proselint.svg)](https://www.npmjs.com/package/proselint) [![Build Status](https://travis-ci.org/sapegin/proselint.svg)](https://travis-ci.org/sapegin/proselint)

[Proselint](http://proselint.com/) wrapper with a friendly reporter. Also skips text in Markdown code blocks.

![Proselint](https://d3vv6lp55qjaqc.cloudfront.net/items/3i3x3B143E1r3g0i0W3R/proselint.png)

## Installation

### macOS

```bash

brew install proselint

npm install -g proselint

```

### Other platforms

```bash

pip install proselint

npm install -g proselint

```

## Usage

```bash

proselintjs filename.md

proselintjs *.md

proselintjs 'pattern/**/*.md'

```

## Configuration

You can disable any rule in `~/.proselintrc`:

```json

{

  "checks": {

    "typography.diacritical_marks": false

  }

}

```

See the original [proselint docs](https://github.com/amperser/proselint/#checks) for more details.

## Changelog

The changelog can be found on the [Releases page](https://github.com/sapegin/proselint/releases).

## Contributing

Everyone is welcome to contribute. Please take a moment to review the [contributing guidelines](Contributing.md).

## Authors and license

[Artem Sapegin](https://sapegin.me) and [contributors](https://github.com/sapegin/proselint/graphs/contributors).

MIT License, see the included [License.md](License.md) file.