@2toad/profanity

中文文档
3.3.0发布于 2026/03/24MITTypeScriptCommonJS零依赖构建来源已验证近 30 天下载 41.3万

具有完整类型脚本支持的多语言淫秽过滤器

中文使用文档
文档目录11 节
  1. 开始
  2. 使用量
  3. 选项
  4. 语言
  5. 全词
  6. 拖动
  7. 格劳利克夏
  8. 自定义单词列表
  9. 白名单
  10. 基准制定
  11. 捐款额

职业

GitHub Release Downloads Build status

具有完整类型脚本支持的多语言淫秽过滤器

开始

安装软件包

npm i @2toad/profanity

如果使用节点11.x或更高,需要安装 专业 1.x

使用量

import { profanity, CensorType } from '@2toad/profanity';
// or
const { profanity, CensorType } = require('@2toad/profanity');
profanity.exists('I like big butts and I cannot lie');
// true

profanity.exists('I like big glutes and I cannot lie');
// false

profanity.censor('I like big butts (aka arses) and I cannot lie');
// I like big @#$%&! (aka @#$%&!) and I cannot lie

profanity.censor('I like big butts (aka arses) and I cannot lie', CensorType.FirstChar);
// I like big *utts (aka *rses) and I cannot lie

选项

创建纯度类实例来更改默认选项 :

import { Profanity } from '@2toad/profanity';

const profanity = new Profanity({
    languages: ['de'],
    wholeWord: false,
    grawlix: '*****',
    grawlixChar: '$',
});

语言

默认设置为 ['en'] (英语). 您可以将默认更改为任意 支持的语言,包括多种语言:

const profanity = new Profanity({
    languages: ['en', 'de'],
});

您可以通过指定语言来覆盖此选项 exists 或者说 censor数字 :

profanity.exists('Je suis un connard', ['fr']);
// true

profanity.censor('I like big butts and je suis un connard', CensorType.Word, ['en', 'de', 'fr']);
// I like big @#$%&! and je suis un @#$%&!

如果方法调用中没有指定语言,它将使用选项中指定的语言.

全词

默认设置为 true 所以,污名只匹配整个词:

profanity.exists('Arsenic is poisonous but not profane');
// false

设为 false,导致部分字词匹配:

profanity.exists('Arsenic is poisonous but not profane');
// true (matched on arse)

复合词

迷信检测在复合词的部分上起作用,而不是将连字符或下划线相分离的单词视为不可分割.

何时 wholeWord 实值 true,对复合词的每个部分进行匹配分析:

profanity.exists("Don't be an arsenic-monster");
// false

profanity.exists("Don't be an arse-monster");
// true (matched on arse)

设置 wholeWord 改为 false,导致复合词的每个部分部分字词匹配:

profanity.exists("Don't be an arsenic-monster");
// true (matched on arse)

单码边界

何时 wholeWord 实值 true,这可以控制字词边界是否具有Unicode-aware。 默认设置为 false 由于性能的影响.

  • 何时 false (默认),全字匹配使用 ASCII 风格的边界(类似于 \b+ 下划线 _ 以为分相. 这对于ASCII输入来说是最快和理想的.
  • 何时 true,全字比对使用Unicode-aware边界,因此有二甲字(如, vehículo, (中文(简体) ), horário)和复合分离器处理正确.
const profanity = new Profanity({ unicodeWordBoundaries: true });

profanity.exists('vehículo horario');
// false (does not match on "culo" inside "vehículo")

拖动

默认设置为 @#$%&!数字 :

profanity.censor('I like big butts and I cannot lie');
// I like big @#$%&! and I cannot lie

设为 ****,结果为:

profanity.censor('I like big butts and I cannot lie');
// I like big **** and I cannot lie

格劳利克夏

当指定 a CensorType 其他 CensorType.Word,这是该 censor 函数.

默认设置为 *数字 :

profanity.censor('I like big butts and I cannot lie', CensorType.AllVowels);
// I like big b*tts and I cannot lie

设为 $,结果为:

profanity.censor('I like big butts and I cannot lie', CensorType.AllVowels);
// I like big b$tts and I cannot lie

自定义单词列表

添加词:

profanity.addWords(['aardvark', 'zebra']);

删除单词 :

profanity.removeWords(['butt', 'arse']);

白名单

白名单允许您指定被亵渎过滤器总是忽略的单词.

如果您想要启用部分单词匹配, 这将会有所帮助( NamewholeWord = false),所以组合词被捕获(如arsellicker),而你加入白名单的具体词被忽略了(如砷).

在白名单中添加单词:

profanity.whitelist.addWords(['arsenic', 'buttress']);

删除白名单中的单词 :

profanity.whitelist.removeWords(['arsenic', 'buttress']);

基准制定

看职业表现如何,看看我们 基准结果。 。 。 .

捐款额

所以你想为职业计划捐款? 厉害! 请读一下 贡献 医生开始.

版本与发布记录

@2toad/profanity 共发布 26 个版本,首次发布于 2019/10/14;过去 12 个月发布了 1 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
3.3.0latest2026/03/247 个月前
3.2.02025/09/131.1 年前
3.1.12024/12/281.9 年前
3.0.12024/10/232 年前
3.0.02024/09/192 年前
2.5.02024/09/142 年前

关于 @2toad/profanity 的常见问题

@2toad/profanity 是什么?

具有完整类型脚本支持的多语言淫秽过滤器

如何安装 @2toad/profanity?

在项目目录运行 npm install @2toad/profanity,或使用 pnpm add / yarn add / bun add。

@2toad/profanity 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@2toad/profanity 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@2toad/profanity 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=12。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@2toad/profanity 可以商用吗?

@2toad/profanity 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@2toad/profanity 的下载量有多少?

根据 npm 官方下载统计,@2toad/profanity 在 2026/10/05 – 2026/11/03 这 30 天内被下载 413,379 次,日均约 13,779 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@2toad/profanity 还在维护吗?

最新版本 3.3.0 发布于 2026/03/24(7 个月前);至今共发布 26 个版本,其中过去 12 个月发布了 1 个;首次发布于 2019/10/14。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。