retext-profanities
Check for profane and vulgar wording with retext. Uses [coparenter-cuss][] for sureness.
Installation
npm:
npm install retext-profanities
Usage
Say we have the following file, example.txt
:
He’s pretty set on beating your butt for sheriff.
And our script, example.js
, looks like this:
var vfile = ;var report = ;var unified = ;var english = ;var stringify = ;var profanities = ; ;
Now, running node example
yields:
example.txt 1:33-1:37 warning Be careful with “butt”, it’s profane in some cases butt retext-profanities ⚠ 1 warning
API
retext().use(profanities[, options])
Check for profanities.
options.ignore
Array.<string>
— phrases not to warn about.
Rules
See rules.md
for a list of rules.
Related
retext-equality
— Check possible insensitive, inconsiderate languageretext-passive
— Check passive voiceretext-simplify
— Check phrases for simpler alternatives