Skip to content

Latest commit

 

History

History
133 lines (101 loc) · 3.59 KB

README.md

File metadata and controls

133 lines (101 loc) · 3.59 KB
Raw

grawlix-racism

Build Status Dependency Status Coverage Status

A plugin for grawlix that focuses on replacing racial and ethnic slurs with nonsensical characters. This module adds filters for twenty-four different racist terms and their variants.

WARNING: THIS PACKAGE DEALS DIRECTLY WITH WORDS AND TERMS THAT MANY FIND OFFENSIVE, IMPOLITE, AND/OR DISTASTEFUL. ALL FILES IN THE REPOSITORY SHOULD BE CONSIDERED NSFW/NOT SAFE FOR WORK OR SCHOOL UNLESS STATED OTHERWISE. PLEASE READ THE SOURCE CODE AT YOUR OWN RISK!

To see the full list of words handled by this plugin, click here (NSFW). To learn more about the grawlix package, visit its repository.

Installation

This plugin requires grawlix.

npm install grawlix-racism --save

Usage

var grawlix = require('grawlix');
grawlix.setDefaults({
  plugins: [
    {
      plugin: require('grawlix-racism'),
      options: {
        style: 'nazi'
      }
    }
  ]
  // other options...
});
// or alternately:
grawlix.loadPlugin('grawlix-racism', {
  style: 'nazi'
});

Options

style

Type: String
Default: 'nazi'

Sets the distinct style of grawlix used to replace racial and ethnic slurs. By default, any slurs found by this plugin will be replaced using its own 'nazi' style, as opposed to whatever main style has been set in the grawlix options. This is intended to specifically highlight and call out filtered content that uses racially-insensitive language.

To turn this feature off, set this property to false in the plugin options:

grawlix.setDefaults({
  plugins: [
    {
      plugin: require('grawlix-racism'),
      options: {
        style: false
      }
    }
  ]
});
// or:
grawlix.loadPlugin('grawlix-racism', {
  style: false
});

You can also use this option to specify a distinct style other than 'nazi':

grawlix.setDefaults({
  style: 'redacted',
  plugins: [
    {
      plugin: require('grawlix-racism'),
      options: {
        style: 'asterix'
      }
    }
  ]
});
// result of these settings: slurs will be replaced by '*' characters,
// while other obscenities will be replaced by '█'s.

Filters

Click here (NSFW) to see a full list of the racial and ethnic slurs targeted by this plugin.

Styles

Nazi

Single-Character Grawlix Style
Name String: 'nazi'
Character: '卐'

Replaces found words with swastika (卐) symbols. Useful for pointing out or calling attention to hate speech.

grawlix.setDefaults({
  style: 'nazi',
  filters: [
    {
      word: 'racialslur',
      pattern: /racialslur/i
    }
  ]
});

grawlix('some kind of racialslur');
// output: 'some kind of 卐卐卐卐卐卐卐卐卐卐'

Testing

npm test

Release History

  • 1.0.2
    • Shortened useDistinctStyle option to style

Credits and Licensing

Created by Jon Stout. Licensed under the MIT license.