readme.md

retext-profanities

retext plugin to check for potential bad words.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • unified().use(retextProfanities[, options])
  • Options
• Data
• Messages
• Types
• Compatibility
• Related
• Contribute
• License

What is this?

This package is a unified (retext) plugin to check for possible profane or otherwise vulgar wording. It uses cuss for sureness.

When should I use this?

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

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install retext-profanities

In Deno with esm.sh:

import retextProfanities from 'https://esm.sh/retext-profanities@8'

In browsers with esm.sh:

<script type="module">
  import retextProfanities from 'https://esm.sh/retext-profanities@8?bundle'
</script>

Use

Say our document example.txt contains:

He’s pretty set on beating your butt for sheriff.

…and our module example.js contains:

import retextEnglish from 'retext-english'
import retextProfanities from 'retext-profanities'
import retextStringify from 'retext-stringify'
import {read} from 'to-vfile'
import {unified} from 'unified'
import {reporter} from 'vfile-reporter'

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

console.error(reporter(file))

…then 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 has an export map with several entries for plugins in different languages:

• retext-profanities/ar-latn — Arabic (Latin-script)
• retext-profanities/en — English
• retext-profanities/es — Spanish
• retext-profanities/fr — French
• retext-profanities/it — Italian
• retext-profanities/pt — Portuguese
• retext-profanities/pt-pt — Portuguese (Portugal)
• retext-profanities — English

Each module exports the plugin retextProfanities as the default export.

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

Check for potential bad words.

Parameters

• options (Options, optional) — configuration

Returns

Transform (Transformer).

Options

Configuration (TypeScript type).

Fields

• ignore (Array<string>, optional) — phrases not to warn about
• sureness (0, 1, or 2, default: 0) — minimum sureness to warn about, see cuss

Data

See cuss.

Messages

Each message is emitted as a VFileMessage, with source set to 'retext-profanities', ruleId to the normalized phrase, actual to the potential bad word, expected to an empty array, and profanitySeverity to the cuss severity of the phrase.

Types

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

Compatibility

Projects maintained by the unified collective are compatible with maintained versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line, retext-profanities@^8, compatible with Node.js 16.

Related

• retext-equality — check possible insensitive, inconsiderate language
• retext-passive — check passive voice
• retext-simplify — check phrases for simpler alternatives

Contribute

See contributing.md in retextjs/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MIT © Titus Wormer