# grunt-naughty-words

> Adapted from Shutterstocks list of Dirty, Naughty, Obscene, and Otherwise Bad Words.

Latest version **1.2.0** (published 2016-08-16) · 0 weekly downloads

## Install

```sh
npm install grunt-naughty-words
pnpm add grunt-naughty-words
yarn add grunt-naughty-words
bun add grunt-naughty-words
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2016-08-16 |
| First published | 2015-03-27 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | jivings |

## Links

- npm: https://www.npmjs.com/package/grunt-naughty-words
- npm.io page: https://npm.io/package/grunt-naughty-words

## Recent versions

- 1.2.0 (latest) — 2016-08-16
- 1.1.0 — 2015-03-27
- 1.0.0 — 2015-03-27

## README

Adapted from Shutterstocks list of Dirty, Naughty, Obscene, and Otherwise Bad Words.

This library provides a grunt task for creating an array of profane words, and a regex to test against, as well as the capability to compile your own obscene word list.

## Installation

    npm install grunt-naughty-words ---save-dev 

    grunt.loadNpmTasks('grunt-naughty-words');
    
## Usage
    
    // creating a list using grunt
    bad_words: {
      options: {
        languages: ['en', 'it', 'de'], // english, italian and german        
        varName: 'profanity',
        namespace: 'App'
      },
      all: {
        dest: 'dist/javascript/profanity.js'
      }
    }

In JavaScript land, include `dist/javascript/profanity.js`, which will expose a regex on the namespaced scope (or globally if namespace not provided):

    App.profanityRegex.test(potentiallyProfaneWord);

## Standalone compilation

You may also build a single one-off file, or one with all languages is provided in the `dist` directory.
    
    # compile naughty words for English, Italian and German
    grunt bad_words:all

Output is found in `dist/badwords.js`.

## Languages

| Name             | Code |
| ---------------- | ---- |
| [Chinese](zh)    | zh   |
| [Czech](cs)      | cs   |
| [Danish](da)     | da   |
| [Dutch](nl)      | nl   |
| [English](en)    | en   |
| [Esperanto](eo)  | eo   |
| [Finnish](fi)    | fi   |
| [French](fr)     | fr   |
| [German](de)     | de   |
| [Hungarian](hu)  | hu   |
| [Italian](it)    | it   |
| [Japanese](ja)   | ja   |
| [Klingon](tlh)   | tlh  |
| [Korean](ko)     | ko   |
| [Norwegian](no)  | no   |
| [Persian](fa)    | fa   |
| [Polish](pl)     | pl   |
| [Portuguese](pt) | pt   |
| [Russian](ru)    | ru   |
| [Spanish](es)    | es   |
| [Swedish](sv)    | sv   |
| [Thai](th)       | th   |
| [Turkish](tr)    | tr   |


## References

Wordlist: © 2012–2015 Shutterstock, Inc.

[![Creative Commons License](http://i.creativecommons.org/l/by/4.0/80x15.png)](http://creativecommons.org/licenses/by/4.0/)

This work is licensed under a [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/).

---
_Source: https://npm.io/package/grunt-naughty-words · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._