Check for profane and vulgar wording with retext. Uses cuss for sureness.
npm:
npm install retext-profanitiesSay 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 = require('to-vfile');
var report = require('vfile-reporter');
var unified = require('unified');
var english = require('retext-english');
var stringify = require('retext-stringify');
var profanities = require('retext-profanities');
unified()
.use(english)
.use(profanities)
.use(stringify)
.process(vfile.readSync('example.txt'), function (err, file) {
console.error(report(err || file));
});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
Check for profanities.
Array.<string> — phrases not to warn about.
See rules.md for a list of rules.
retext-equality— Check possible insensitive, inconsiderate languageretext-passive— Check passive voiceretext-simplify— Check phrases for simpler alternatives
See contribute.md in retextjs/retext for ways to get started.
This organisation has a Code of Conduct. By interacting with this repository, organisation, or community you agree to abide by its terms.