retext-profanities

retext plugin to check for profane and vulgar wording

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
retext-profanities
3807.2.28 days ago7 years agoMinified + gzip package size for retext-profanities in KB

Readme

retext-profanities
!Buildbuild-badgebuild !Coveragecoverage-badgecoverage !Downloadsdownloads-badgedownloads !Sizesize-badgesize !Sponsorssponsors-badgecollective !Backersbackers-badgecollective !Chatchat-badgechat
retext plugin to check for possible profane and vulgar wording.

Contents

*   [`unified().use(retextProfanities[, options])`](#unifieduseretextprofanities-options)

What is this?

This package is a unified
(retext) plugin to check for possible profane or otherwise vulgarprofanities wording, in certain contexts. It uses cusscuss for sureness.

When should I use this?

You can opt-into this plugin when you’re dealing with your own text and want to check for potential mistakes.

Install

This package is ESM onlyesm. In Node.js (version 14.14+, 16.0+), install with npm:
npm install retext-profanities

In Deno with esm.shesmsh:
import retextProfanities from 'https://esm.sh/retext-profanities@7'

In browsers with esm.shesmsh:
<script type="module">
  import retextProfanities from 'https://esm.sh/retext-profanities@7?bundle'
</script>

Use

Say our document example.txt contains:
He’s pretty set on beating your butt for sheriff.

…and our module example.js looks as follows:
import {read} from 'to-vfile'
import {reporter} from 'vfile-reporter'
import {unified} from 'unified'
import retextEnglish from 'retext-english'
import retextProfanities from 'retext-profanities'
import retextStringify from 'retext-stringify'

const file = await unified()
  .use(retextEnglish)
  .use(retextProfanities)
  .use(retextStringify)
  .process(await read('example.txt'))

console.error(reporter(file))

…now running node example.js yields:
example.txt
  1:33-1:37  warning  Be careful with “butt”, it’s profane in some cases  butt  retext-profanities

⚠ 1 warning

API

This package exports no identifiers. The default export is retextProfanities.

unified().use(retextProfanities[, options])

Check for possible profane and vulgar wording.
options
Configuration (optional).
options.ignore
Phrases not to warn about (Array<string>, default: []).
options.sureness
Minimum sureness to warn about, see cusscuss (number, default: 0).

Rules

See rules.mdrules for a list of rules.
Note that Latin-script Arabic (retext-profanities/ar-latn), French (retext-profanities/fr), Spanish (retext-profanities/es), Italian (retext-profanities/it), and Portuguese (Brazilian) (retext-profanities/pt) are also supported.

Messages

See rules.mdrules for a list of rules and how rules work.
Each message is emitted as a VFileMessagevfile-message on file, with the following fields:
message.source
Name of this plugin ('retext-profanities').
message.ruleId
See id in rules.mdrules.
message.profanitySeverity
Cuss sureness (number).
message.actual
Profane phrase (string).
message.expected
Empty array to signal that actual should be removed or changed ([]).

Types

This package is fully typed with TypeScript. It exports the additional type Options.

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed. It also works in Deno and modern browsers.

Related

— check possible insensitive, inconsiderate language
— check passive voice
— check phrases for simpler alternatives

Contribute

See contributing.mdcontributing in retextjs/.githubhealth for ways to get started. See support.mdsupport for ways to get help.
This project has a code of conductcoc. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MITlicense © Titus Wormerauthor