1.0.8 • Published 4 months ago

russian-bad-word-censor v1.0.8

Weekly downloads
-
License
MIT
Repository
github
Last release
4 months ago

Russian-Bad-Words

License

Russian-Bad-Word — это библиотека для поиска и замены нецензурных слов в тексте. Она поддерживает обработку текста на русском и английском языках, учитывает замены символов (например, "з" на "3" или "a" на "@") и позволяет добавлять собственные шаблоны для поиска нецензурных слов.

Установка

Вы можете установить Russian-Bad-Word с помощью npm:

npm i russian-bad-word-censor

с помощью yarn:

yarn add russian-bad-word-censor

Использование

Основной пример

Использование Основной пример

import { RuCensor } from 'russian-bad-word-censor';

// Пример текста
const text = "Этот текст содержит нецензурное слово: х*y";

// Проверка и замена нецензурных слов
const result = RuCensor.replace(text, "*");
const isNeededToCheck = RuCensor.isContainsBadWords(text) // bool

console.log(result);
// Output: "Этот текст содержит нецензурное слово: ***"

console.log(isNeededToCheck)
// Output: true

Добавление собственных шаблонов

Вы можете добавлять собственные шаблоны для поиска нецензурных слов:

RuCensor.addBadWordPattern('[о][н]');

const text = "Он шёл по дорожке";
const result = RuCensor.replace(text, "*");

console.log(result);
// Output: ** шёл по дорожке 

Добавление слов, которые будут пропущены

Вы можете добавить слова, которые не будут считаться нецензурными:

RuCensor.addWordsToPass("заштрихуй");

const text = "Это слово заштрихуй не будет заменено.";
const result = RuCensor.replace(text, "[цензура]");

console.log(result);
// Output: "Это слово заштрихуй не будет заменено."

API

API RuCensor.replace(text: string, replace: string): string

Проверяет текст на наличие нецензурных слов и заменяет их на указанную строку.

  • text: Текст для проверки.

  • replace: Строка для замены нецензурных слов.

  • Возвращает: Обработанный текст.

RuCensor.isContainsBadWords(text: string): boolean

Проверяет текст на наличие нецензурных слов.

  • text: Текст для проверки.

  • Возвращает: true, если найдены нецензурные слова, иначе false.

RuCensor.addBadWordPattern(pattern: string): void

Добавляет новый паттерн для поиска нецензурных слов.

  • pattern: Регулярное выражение или строка для поиска.

RuCensor.addWordsToPass(word: string): void

Добавляет слово, которое будет пропущено при проверке.

  • word: Слово, которое не будет считаться нецензурны

Идея алгоритма взята у https://github.com/rin-nas/php-censure.

1.0.8

4 months ago

1.0.7

4 months ago

1.0.6

4 months ago

1.0.5

4 months ago

1.0.4

4 months ago

1.0.3

4 months ago

1.0.2

4 months ago

1.0.1

4 months ago

1.0.0

4 months ago