textlint-rule-stop-words

textlint rule to find filler words, buzzwords and clichés — 1600+ words and phrases in English.

For example:

• and etc.
• the month of
• thick as a brick
• utilize

(You can disable some words or add your own.)

Installation

npm install textlint-rule-stop-words

Usage

textlint --fix --rule stop-words Readme.md

Configuration

You can configure the rule in your .textlintrc:

{
  "rules": {
    "stop-words": {
      // Load default dictionary (see dict.txt in the repository)
      "defaultWords": true,
      // Syntax elements to skip. Overrides the default
      "skip": ["Blockquote"],
      // Extra words
      "words": [
        ["etc."],
        ["you can"],
        // With a replacement
        ["blacklist", "denylist"],
        // Ensure correct capitalization
        ["asciidoc", "AsciiDoc"]
      ],
      // Excluded words
      "exclude": [
        "utilize",
        "period of time"
      ],
      // OR load terms from a file
      "words": "~/stop-words.txt"
    }
  }
}

Check the default dictionary. Read more about configuring textlint.

Tips & tricks

Use textlint-filter-rule-comments to disable stop-words check for particular paragraphs:

<!-- textlint-disable stop-words -->

Oh my javascript!

<!-- textlint-enable -->

Sources

• Grammar & Writing for Creators
• 297 Flabby Words and Phrases That Rob Your Writing of All Its Power
• no-cliches
• fillers
• hedges
• weasels
• buzzwords
• retext-simplify

Other textlint rules

• textlint-rule-apostrophe — correct apostrophe usage
• textlint-rule-diacritics — words with diacritics
• textlint-rule-terminology — correct terms spelling
• textlint-rule-title-case — fix titles to use AP/APA style

Change log

The change log can be found on the Releases page.

Contributing

Bug fixes are welcome, but not new features. Please take a moment to review the contributing guidelines.

Sponsoring

This software has been developed with lots of coffee, buy me one more cup to keep it going.

Authors and license

Artem Sapegin and contributors.

MIT License, see the included License.md file. Also see the project status.