4.0.0 • Published 7 months ago

textlint-rule-stop-words v4.0.0

Weekly downloads
1,572
License
MIT
Repository
github
Last release
7 months ago

textlint-rule-stop-words

textlint fixable rule npm Node.js CI status

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.)

npm.io

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

Other textlint rules

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.

3.0.2

7 months ago

4.0.0

7 months ago

3.0.1

2 years ago

3.0.0

2 years ago

2.0.9

3 years ago

2.0.8

3 years ago

2.0.7

4 years ago

2.0.6

4 years ago

2.0.5

4 years ago

2.0.4

4 years ago

2.0.3

4 years ago

2.0.2

4 years ago

2.0.1

4 years ago

2.0.0

4 years ago

1.0.18

4 years ago

1.0.17

5 years ago

1.0.16

5 years ago

1.0.15

5 years ago

1.0.14

5 years ago

1.0.13

5 years ago

1.0.12

5 years ago

1.0.11

5 years ago

1.0.10

5 years ago

1.0.9

5 years ago

1.0.8

5 years ago

1.0.7

5 years ago

1.0.6

5 years ago

1.0.5

6 years ago

1.0.4

6 years ago

1.0.3

6 years ago

1.0.2

6 years ago

1.0.1

6 years ago

1.0.0

7 years ago