@q78kg/koishi-plugin-text-censor 1.0.2

package/lib/index.d.ts

@@ -0,0 +1,9 @@
+import { Context, Schema } from 'koishi';
+export declare const name = "text-censor";
+export interface Config {
+    filename: string;
+    removeWords: boolean;
+    transformToUpper: boolean;
+}
+export declare const Config: Schema<Config>;
+export declare function apply(ctx: Context, config: Config): void;

package/lib/index.js

@@ -0,0 +1,88 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __export = (target, all) => {
+  for (var name2 in all)
+    __defProp(target, name2, { get: all[name2], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  Config: () => Config,
+  apply: () => apply,
+  name: () => name
+});
+module.exports = __toCommonJS(src_exports);
+var import_koishi = require("koishi");
+var import_node_fs = require("node:fs");
+var import_node_path = require("node:path");
+var import_censor = __toESM(require("@koishijs/censor"));
+var import_mint_filter = __toESM(require("mint-filter"));
+var name = "text-censor";
+var Config = import_koishi.Schema.object({
+  filename: import_koishi.Schema.string().description("存储敏感词的文件路径。").default("data/censor.txt"),
+  removeWords: import_koishi.Schema.boolean().description("是否直接删除敏感词。").default(false),
+  // 默认不删除敏感词
+  transformToUpper: import_koishi.Schema.boolean().description("是否将字符转换为大写。").default(false)
+  // 默认不转换字符为大写
+});
+function apply(ctx, config) {
+  const filename = (0, import_node_path.resolve)(ctx.baseDir, config.filename);
+  if (!(0, import_node_fs.existsSync)(filename)) {
+    ctx.logger.warn("dictionary file not found");
+    return;
+  }
+  const source = (0, import_node_fs.readFileSync)(filename, "utf8");
+  const words = source.split("\n").map((word) => word.trim()).filter((word) => word && !word.startsWith("//") && !word.startsWith("#"));
+  const mintOptions = {
+    transform: config.transformToUpper ? "capital" : "none"
+    // 这里我们将值设置为可能的类型
+  };
+  const filter = new import_mint_filter.default(words, mintOptions);
+  ctx.plugin(import_censor.default);
+  ctx.get("censor").intercept({
+    async text(attrs) {
+      const result = await filter.filter(attrs.content);
+      if (typeof result.text !== "string")
+        return [];
+      if (config.removeWords) {
+        const filteredText = words.reduce((text, word) => {
+          const regex = new RegExp(`\\b${word}\\b`, "gi");
+          return text.replace(regex, "");
+        }, result.text);
+        return [filteredText.trim()];
+      } else {
+        return [result.text];
+      }
+    }
+  });
+}
+__name(apply, "apply");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Config,
+  apply,
+  name
+});

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@q78kg/koishi-plugin-text-censor",
+  "description": "A text censor provider for Koishi",
+  "version": "1.0.2",
+  "main": "lib/index.js",
+  "typings": "lib/index.d.ts",
+  "files": [
+    "lib"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Hoshino-Yumetsuki/koishi-plugin-text-censor.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Hoshino-Yumetsuki/koishi-plugin-text-censor/issues"
+  },
+  "homepage": "https://censor.koishi.chat/plugins/text.html",
+  "keywords": [
+    "bot",
+    "chatbot",
+    "koishi",
+    "plugin",
+    "censor",
+    "filter",
+    "security",
+    "text"
+  ],
+  "koishi": {
+    "service": {
+      "implements": [
+        "censor"
+      ]
+    },
+    "description": {
+      "en": "Filter out sensitive words in text messages",
+      "zh": "文本敏感词过滤"
+    }
+  },
+  "peerDependencies": {
+    "koishi": "^4.17.9"
+  },
+  "devDependencies": {
+    "koishi": "^4.17.9"
+  },
+  "dependencies": {
+    "@koishijs/censor": "^1.0.1",
+    "mint-filter": "^3.0.1"
+  }
+}

package/readme.md

@@ -0,0 +1,9 @@
+# @q78kg/koishi-plugin-text-censor
+ 
+[![npm](https://img.shields.io/npm/v/@q78kg/koishi-plugin-text-censor?style=flat-square)](https://www.npmjs.com/package/@q78kg/koishi-plugin-text-censor)
+
+此插件基于 Aho–Corasick 算法，对输入的文本内容进行过滤，并将所有的敏感词替换为 `*`。
+
+## 文档
+
+<https://censor.koishi.chat/plugins/text.html>