https://github.com/admhlt/retext-usage

Warn about incorrect English usage with retext
https://github.com/admhlt/retext-usage

Last synced: about 2 months ago
JSON representation

Warn about incorrect English usage with retext

• Host: GitHub
• URL: https://github.com/admhlt/retext-usage
• Owner: adamhollett
• License: mit
• Created: 2016-03-05T03:53:56.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2018-01-03T16:37:21.000Z (about 7 years ago)
• Last Synced: 2024-04-14T06:51:59.364Z (10 months ago)
• Language: JavaScript
• Homepage:
• Size: 366 KB
• Stars: 11
• Watchers: 1
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: readme.md
  • Changelog: history.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# retext-usage

Check phrases for incorrect English usage with [**retext**][retext].

## Usage

```js

var retext = require('retext');

var usage = require('retext-usage');

var report = require('vfile-reporter');

retext()

    .use(usage)

    .process([

        'Repeat ad nauseum.',

        'Get some money from the ATM machine.',

        'This is majorly inappropriate.'

    ].join('\n'), function (err, file) {

        console.log(report(file));

    });

```

Yields:

```txt

   1:8-1:18  warning  Replace “ad nauseum” with “ad nauseam”                      ad nauseum

  2:25-2:36  warning  Replace “ATM machine“ with “ATM”                            ATM machine

   3:9-3:16  warning  Replace “majorly” with “extremely”, or remove it            majorly

⚠ 3 warnings

```

## License

[MIT][license] © [Adam Hollett][author]

[releases]: https://github.com/wooorm/retext-usage/releases

[license]: LICENSE

[author]: http://adamhollett.com

[retext]: https://github.com/wooorm/retext