words/profanities

🤬 List of (possible) profane words

profanities

List of profane words.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • profanities
• Data
• Types
• Compatibility
• Related
• Contributing
• Security
• License

What is this?

This package exposes lists of profane words in several languages.

When should I use this?

This is a flat list of words. See cuss for the same words, rated for sureness: how likely they are to be used as either profanity or clean text.

Install

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

npm install profanities

In Deno with esm.sh:

import {profanities} from 'https://esm.sh/profanities@3'

In browsers with esm.sh:

<script type="module">
  import {profanities} from 'https://esm.sh/profanities@3?bundle'
</script>

Use

import {profanities} from 'profanities'
import {profanities as profanitiesFr} from 'profanities/fr'

console.log(profanities.includes('butt')) // true
console.log(profanitiesFr.includes('boule')) // true

API

profanities exports the following entries:

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

Each entry exports the identifier profanities. There are no default exports.

profanities

List of strings (Array<string>).

Data

The data includes many profane words and phrases in different languages. In many contexts, those words are not profane though. See cuss for the terms (and a rating of sureness).

Types

This package is fully typed with TypeScript. It exports no additional types.

Compatibility

This package is at least compatible with all maintained versions of Node.js. As of now, that is Node.js 14.14+, 16.0+, and 18.0+. It also works in Deno and modern browsers.

Related

• buzzwords — list of buzzwords
• cuss — map of profane words to a rating of sureness
• dale-chall — list of familiar English words (1995)
• fillers — list of filler words
• hedges — list of hedge words
• spache — list of easy English words (1974)
• weasels — list of weasel words

Contributing

Yes please! See How to Contribute to Open Source.

Words and new languages can be added to cuss. After they are added there, this project can be built to include the changes.

Security

This package is safe.

License

MIT © Titus Wormer

profanities's Issues

[Feature] Add a function that detect if a profane word is used in a sentence.

Hello, that's would be cool if we can do that :
if(profanities.profane('Hello bitch!'){ // true

When is "American" profane?

I ran some text through Alex, and it told me "American" is profane in some cases. Thanks, Trump. 😝

More seriously, I can't think of a context in which "American" would be profane, and its presence in this package seems likely to generate almost entirely false positives. Should it be removed? (There are probably others in this category too.)

It looks like the origin of "American" here is Luis von Ahn's research group's Offensive/Profane Word List.

node 14 import error

Hi, we're using node.js v14.x with esm: true, but when we import profanities v3.0.0 we get:

Error [ERR_REQUIRE_ESM]: Must use import to load ES Module: /home/matthew/dev/ce/compiler-explorer/node_modules/profanities/index.js
require() of ES modules is not supported.
require() of /home/matthew/dev/ce/compiler-explorer/node_modules/profanities/index.js from /home/matthew/dev/ce/compiler-explorer/lib/storage/base.js is an ES module file as it is a .js file whose nearest parent package.json contains "type": "module" which defines all .js files in that package scope as ES modules.
Instead rename index.js to end in .cjs, change the requiring code to use import(), or remove "type": "module" from /home/matthew/dev/ce/compiler-explorer/node_modules/profanities/package.json.

    at new NodeError (internal/errors.js:322:7)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:1102:13) {
  code: 'ERR_REQUIRE_ESM'
}

The same worked ok with profanities 2.14.0. The offending line in our code does /not/ use require, despite the error:

import { profanities } from 'profanities';

(see https://github.com/compiler-explorer/compiler-explorer/blob/b3521cc1ec217db7294316dd919e86876575654a/lib/storage/base.js#L25 which has the code for v2.14.0 checked in)

no joke, I was about to publish this last night lol

On my life I had the package put together and you beat me to it lol! I'll just use this one now.

I was going to do it a bit differently though. I exposed methods for getting specific words, like the 7 most common cuss words is exposed on the .carlin property. or if you want a list of common, non-cuss words that still manage to offend people, you can get the list from the .jonschlinkert property.

Seriously though, stop reading my mind! (feel free to close, just wanted to stop by. nice work!)

`index.json` seems to be missing

I might be missing something, but index.json doesn't seem to be in the source files. Thank you.