https://github.com/sapegin/textlint-rule-stop-words
Textlint rule to find filler words, buzzwords and clichés
https://github.com/sapegin/textlint-rule-stop-words
buzzwords cliche fillers linter textlint textlint-rules
Last synced: 10 months ago
JSON representation
Textlint rule to find filler words, buzzwords and clichés
- Host: GitHub
- URL: https://github.com/sapegin/textlint-rule-stop-words
- Owner: sapegin
- License: mit
- Created: 2017-10-20T18:55:39.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-10-30T08:04:40.000Z (over 1 year ago)
- Last Synced: 2025-05-15T17:06:28.108Z (about 1 year ago)
- Topics: buzzwords, cliche, fillers, linter, textlint, textlint-rules
- Language: TypeScript
- Homepage:
- Size: 697 KB
- Stars: 20
- Watchers: 2
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- Contributing: Contributing.md
- License: License.md
Awesome Lists containing this project
README
# textlint-rule-stop-words
[](https://textlint.github.io/) [](https://www.npmjs.com/package/textlint-rule-stop-words) [](https://github.com/sapegin/textlint-rule-stop-words/actions)
[textlint](https://github.com/textlint/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.)
[](https://sapegin.me/book/)
## Installation
```shell
npm install textlint-rule-stop-words
```
## Usage
```shell
textlint --fix --rule stop-words Readme.md
```
## Configuration
You can configure the rule in your `.textlintrc`:
```js
{
"rules": {
"stop-words": {
// Your options here
}
}
}
```
Read more about [configuring textlint](https://github.com/textlint/textlint/blob/master/docs/configuring.md).
### `defaultWords` (default: `true`)
Whether to load the [default dictionary](./dict.txt). Example:
```js
{
"rules": {
"stop-words": {
// Don't load default dictionary
"defaultWords": false,
}
}
}
```
### `skip` (default `['BlockQuote']`)
Syntax elements to skip. By default skips blockquotes. Example:
```js
{
"rules": {
"stop-words": {
// Don't check terms inside links
"skip": ["Link"],
}
}
}
```
See [all available element types](https://github.com/textlint/textlint/blob/master/packages/%40textlint/ast-node-types/src/ASTNodeTypes.ts).
### `words`
Additional words.
Could be an array of words:
```js
{
"rules": {
"stop-words": {
// List of words
"words": [
// Exact words
["etc."],
["you can"],
// With a replacement
["blacklist", "denylist"]
],
}
}
}
```
A path to a text file:
```js
{
"rules": {
"stop-words": {
// Load words from a file
"words": "~/stop-words.txt"
}
}
}
```
Check out [the default dictionary](./dict.txt).
### `exclude`
If you don’t like some of [the default words](./dict.txt), you can _exclude_ them. For example, to exclude these entries:
```txt
// 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:
```js
{
"rules": {
"stop-words": {
// Excludes terms
"exclude": [
"utilize",
"period of time"
]
}
}
}
```
## Tips & tricks
Use [textlint-filter-rule-comments](https://github.com/textlint/textlint-filter-rule-comments) to disable stop-words check for particular paragraphs:
```markdown
Oh my javascript!
```
## Sources
- Grammar & Writing for Creators
- [297 Flabby Words and Phrases That Rob Your Writing of All Its Power](https://smartblogger.com/weak-writing/)
- [no-cliches](https://github.com/dunckr/no-cliches/)
- [fillers](https://github.com/wooorm/fillers/)
- [hedges](https://github.com/wooorm/hedges/)
- [weasels](https://github.com/wooorm/weasels/)
- [buzzwords](https://github.com/wooorm/buzzwords/)
- [retext-simplify](https://github.com/wooorm/retext-simplify/)
## Other textlint rules
- [textlint-rule-apostrophe](https://github.com/sapegin/textlint-rule-apostrophe) — correct apostrophe usage
- [textlint-rule-diacritics](https://github.com/sapegin/textlint-rule-diacritics) — words with diacritics
- [textlint-rule-terminology](https://github.com/sapegin/textlint-rule-terminology) — correct terms spelling
- [textlint-rule-title-case](https://github.com/sapegin/textlint-rule-title-case) — fix titles to use AP/APA style
## Change log
The change log can be found on the [Releases page](https://github.com/sapegin/textlint-rule-stop-words/releases).
## Contributing
Bug fixes are welcome, but not new features. Please take a moment to review the [contributing guidelines](Contributing.md).
## Sponsoring
This software has been developed with lots of coffee, buy me one more cup to keep it going.
## Authors and license
[Artem Sapegin](https://sapegin.me) and [contributors](https://github.com/sapegin/textlint-rule-stop-words/graphs/contributors).
MIT License, see the included [License.md](License.md) file. Also see the [project status](https://github.com/sapegin/textlint-rule-stop-words/discussions/45).