Textlint rule to find filler words, buzzwords and clichés
MIT License
textlint rule to find filler words, buzzwords, and clichés — 1700+ words and phrases in English.
For example:
(You can disable some words or add your own.)
npm install textlint-rule-stop-words
textlint --fix --rule stop-words Readme.md
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"
]
}
}
}
Use textlint-filter-rule-comments to disable stop-words check for particular paragraphs:
<!-- textlint-disable stop-words -->
Oh my javascript!
<!-- textlint-enable -->
The change log can be found on the Releases page.
Bug fixes are welcome, but not new features. Please take a moment to review the contributing guidelines.
This software has been developed with lots of coffee, buy me one more cup to keep it going.
Artem Sapegin and contributors.
MIT License, see the included License.md file. Also see the project status.