# @2toad/profanity 中文文档

规范地址：https://npmcn.com/package/%402toad/profanity/

版本：3\.3\.0
npm 元数据更新时间：2026-03-24T02:51:05.064Z
中文译文更新时间：2026-11-05T17:26:42.762Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%402toad/profanity
原文对照：https://npmcn.com/package/%402toad/profanity/?lang=original
项目主页：https://github.com/2Toad/Profanity
源码仓库：https://github.com/2Toad/Profanity

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：179 kB，35 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=12
- 运行依赖：0 个
- 首次发布：2019-10-13T23:26:26.182Z
- 最新版本发布：2026-03-24T02:51:04.708Z
- 近 30 天下载量：413379（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：26（近 12 个月 1 个）

## 中文简介

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

## 安装

```sh
npm install @2toad/profanity
```

也可以使用：`pnpm add @2toad/profanity`、`yarn add @2toad/profanity`、`bun add @2toad/profanity`

## README

# 职业

![GitHub Release](https://img.shields.io/github/v/release/2Toad/Profanity) [![Downloads](https://img.shields.io/npm/dm/@2toad/profanity.svg)](https://www.npmjs.com/package/@2toad/profanity) [![Build status](https://github.com/2toad/profanity/actions/workflows/ci.yml/badge.svg)](https://github.com/2Toad/Profanity/actions/workflows/nodejs.yml)

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

## 开始

安装软件包

```Shell
npm i @2toad/profanity
```

> 如果使用节点11.x或更高,需要安装 [专业 1.x](https://github.com/2Toad/Profanity/releases)

## 使用量

```JavaScript
import { profanity, CensorType } from '@2toad/profanity';
// or
const { profanity, CensorType } = require('@2toad/profanity');
```

```JavaScript
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
```

## 选项

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

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

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

### 语言

默认设置为 `['en']` (英语). 您可以将默认更改为任意 [支持的语言](https://npmcn.com/package/%402toad/profanity/supported-languages.md),包括多种语言:

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

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

```JavaScript
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` 所以,污名只匹配整个词:

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

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

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

#### 复合词

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

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

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

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

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

```JavaScript
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`)和复合分离器处理正确.

```JavaScript
const profanity = new Profanity({ unicodeWordBoundaries: true });

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

### 拖动

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

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

设为 `****`,结果为:

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

### 格劳利克夏

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

默认设置为 `*`数字 :

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

设为 `$`,结果为:

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

## 自定义单词列表

添加词:

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

删除单词 :

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

## 白名单

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

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

在白名单中添加单词:

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

删除白名单中的单词 :

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

## 基准制定

看职业表现如何,看看我们 [基准结果](https://npmcn.com/package/%402toad/profanity/src/tools/benchmark/results.md)。 。 。 .

## 捐款额

所以你想为职业计划捐款? 厉害! 请读一下 [贡献](https://npmcn.com/package/%402toad/profanity/contribute.md) 医生开始.

## 常见问题

### @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 和提交记录判断。