This package provides the following services:
linter-retextjs
A plugin for Atom's Linter providing an interface to retext. Retext is a natural language processor that includes plugins to check for bad prose. The full list of retext plugins is here. The code is hosted at https://github.com/benmarwick/linter-retextjs
This package is like a super-set of linters that combines the checks provided by linter-alex, write-good, linter-just-say-no, and others. It was inspired by the discussion on the Using Atom for academic writing
This package provides these retext checkers:
- cliches: Checks phrases for cliches
- equality: checks for possible insensitive, inconsiderate language, equivalent to linter-alex
- intensify: check for weak and mitigating wording, similar to linter-just-say-no
- profanities: check for profane and vulgar wording
- passive: check for passive voice, similar to linter-write-good
- repeated words: check for repeated words
- simplify: check phrases for simpler alternatives
- contractions: check apostrophe use in contractions
- usage: warn about incorrect English usage, similar to linter-proselint.
- indefinite article: check if indefinite articles (
a
,an
) are used correctly - diacritics: check for proper use of diacritics
It does not include readability, because that works at sentence-level while the others work at word- or short-phrase-level. The absence of this checker, and the addition of several others, are the main differences with camjc/atom-linter-retext
Installation
Command Line
- Install Atom
- In the terminal, install the package via apm:
apm install linter-retextjs
GUI
- Install Atom
- Launch Atom
- Open Settings View using Cmd+, on macOS or Ctrl+, on other platforms
- Click the Install tab on the left side
- Enter
linter-retextjs
in the search box and press Enter - Click the "Install" button that appears
Running locally
Clone and install from your disc to experiment with modifications:
git clone https://github.com/benmarwick/linter-retextjs.git
cd linter-retextjs
apm install
Contributing
Issues regarding linter-retextjs should be opened in this repository. Please raise issues with retext on its repository.
License
MIT © Cameron Chamberlain & Ben Marwick
Based on atom-linter-alex: MIT © Titus Wormer