描述
Google禁用的完整不良词汇和顶级脏话列表。该列表每月更新。欢迎提交拉取请求!
@coffeeandfun/google-profanity-words
是由Coffee & Fun LLC的Robert James Gabriel创建的Node.js模块。它旨在帮助您识别和管理给定文本中的亵渎词。该模块提供了获取所有已知亵渎词列表、检查特定词是否被认为是亵渎词以及适当处理空字符串的功能。
安装
您可以使用npm安装@coffeeandfun/google-profanity-words
模块:
npm install @coffeeandfun/google-profanity-words
使用方法
要使用@coffeeandfun/google-profanity-words
,首先导入模块并创建一个实例:
import { ProfanityEngine } from '@coffeeandfun/google-profanity-words';
// 传递'language'参数以指定语言(可选)。
// 如果未提供有效的语言代码,默认为'en'。
const profanity = new ProfanityEngine({ language: 'es' });
language参数是可选的,可用于指定亵渎词列表的语言。如果未提供有效的语言代码,默认为'en'。如果找不到指定的语言文件,它将回退到'en'语言文件并显示控制台警告。
API功能
1. all()
以数组形式检索所有亵渎词。
const allWords = await profanity.all();
2. search(word)
检查给定词是否被认为是亵渎词。
const searchWord = await profanity.search('shit');
// 如果该词是亵渎词则返回true,否则返回false。
3. hasCurseWords(sentence)
检查给定句子是否包含任何亵渎词。
const sentence = 'Do not use bad words like mierda or idiota.';
const hasCurseWords = await profanity.hasCurseWords(sentence);
// 如果句子包含亵渎词则返回true,否则返回false。
4. 处理空字符串
search
和hasCurseWords
函数对任何空字符串都会返回false。
const searchWord = await profanity.search('');
const hasCurseWords = await profanity.hasCurseWords('');
// 对空字符串返回false。
测试
@coffeeandfun/google-profanity-words
带有使用Jest框架的测试套件。要运行测试,请使用以下命令:
npm test
贡献
欢迎对此模块做出贡献!如果您发现任何问题或有改进建议,请随时在GitHub仓库上开启问题或创建拉取请求。
许可证
本项目采用MIT许可证。
致谢
特别感谢Robert James Gabriel和Coffee & Fun LLC创建并维护此模块,以及Jest团队提供的测试框架。您的努力使这个模块更加可靠和稳健。