badwords-ko

A javascript filter for badwords

Description

이 npm 은 한국어 비속어를 필터링하기 위해 만들어졌습니다. (This npm was created to filter out Korean profanity.)
It was built using npm filtering the profanity below.

Reference

Requirements

Requires you either have an environment that understands ES2016 and beyond or a transpiler like Babel.

Installation

npm install badwords-ko --save

Usage

import Filter from "badwords-ko";

const filter = new Filter();

console.log(filter.clean("욕을 합니다 개새끼")); // 욕을 합니다 ***

Placeholder Overrides

import Filter from "badwords-ko";
const customFilter = new Filter({ placeHolder: "x" });

customFilter.clean("욕을 합니다 개새끼"); // 욕을 합니다 xxx

Regex Overrides

const filter = new Filter({ regex: /\*|\.|$/gi });

const filter = new Filter({ replaceRegex: /[A-Za-z0-9가-힣_]/g });
//multilingual support for word filtering

Add words to the blacklist

const filter = new Filter();

filter.addWords("무진장", "나쁜", "말");

filter.clean("무진장 나쁜 말!"); //**** *** ****!

//or use an array using the spread operator

const newBadWords = ["무진장", "나쁜", "말"];

filter.addWords(...newBadWords);

filter.clean("무진장 나쁜 말!"); //**** *** ****!

//or

const filter = new Filter({ list: ["무진장", "나쁜", "말"] });

filter.clean("무진장 나쁜 말!"); //**** *** ****!

Instantiate with an empty list

const filter = new Filter({ emptyList: true });
filter.clean("아무것도 지워지지 않습니다. "); //hell this wont clean anything

Remove words from the blacklist

let filter = new Filter();

filter.removeWords("시발", "에라이퉷");

filter.clean("some 시발 에이라이퉷!"); //some 시발 에이라이퉷!

//or use an array using the spread operator

let removeWords = ["시발", "에라이퉷"];

filter.removeWords(...removeWords);

filter.clean("some 에라이퉷 시발 에이라이퉷!"); //some 에라이퉷 시발 에라이퉷!

API

constructor

Filter constructor.

Parameters

• options object Filter instance options (optional, default {})
  • options.emptyList boolean Instantiate filter with no blacklist
  • options.list array Instantiate filter with custom list
  • options.placeHolder string Character used to replace profane words.
  • options.regex string Regular expression used to sanitize words before comparing them to blacklist.
  • options.replaceRegex string Regular expression used to replace profane words with placeHolder.

isProfane

Determine if a string contains profane language.

Parameters

• string string String to evaluate for profanity.

replaceWord

Replace a word with placeHolder characters;

Parameters

• string string String to replace.

clean

Evaluate a string for profanity and return an edited version.

Parameters

• string string Sentence to filter.

addWords

Add word(s) to blacklist filter / remove words from whitelist filter

Parameters

• word ...string Word(s) to add to blacklist

removeWords

Add words to whitelist filter

Parameters

• word ...string Word(s) to add to whitelist.

Testing

npm test

License

The MIT License (MIT)

Copyright (c) 2015 Michael Price

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.