textlint-rule-stop-words

textlint rule to find filler words, buzzwords, and clichés — 1700+ 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": {
      // Your options here
    }
  }
}

Read more about configuring textlint.

defaultWords (default: true)

Whether to load the default dictionary. Example:

{
  "rules": {
    "stop-words": {
      // Don't load default dictionary
      "defaultWords": false,
    }
  }
}

skip (default ['BlockQuote'])

Syntax elements to skip. By default skips blockquotes. Example:

{
  "rules": {
    "stop-words": {
      // Don't check terms inside links
      "skip": ["Link"],
    }
  }
}

See all available element types.

words

Additional words.

Could be an array of words:

{
  "rules": {
    "stop-words": {
      // List of words
      "words": [
        // Exact words
        ["etc."],
        ["you can"],
        // With a replacement
        ["blacklist", "denylist"]
      ],
    }
  }
}

A path to a text file:

{
  "rules": {
    "stop-words": {
      // Load words from a file
      "words": "~/stop-words.txt"
    }
  }
}

Check out the default dictionary.

exclude

If you don’t like some of the default words, you can exclude them. For example, to exclude these entries:

// dict.txt
utilize > use
period of time

You need to copy the exact entry (for words with replacement, just the first element) to the exclude option of the stop-words rule in your Textlint config:

{
  "rules": {
    "stop-words": {
      // Excludes terms
      "exclude": [
        "utilize",
        "period of time"
      ]
    }
  }
}

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.