@q78kg/koishi-plugin-text-censor 1.0.4-beta.9 → 1.0.9

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020-present Shigma
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/{readme.md → README.md}

@@ -1,8 +1,8 @@
 # @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 算法，对输入的文本内容进行过滤，并将所有的敏感词替换为 `*`。
+此插件基于 Aho–Corasick 算法，对输入的文本内容进行过滤，并将所有的敏感词替换为 `*`。并支持基于上下文匹配的敏感词删除模式。
 
 ## 文档
 

package/lib/index.cjs

@@ -0,0 +1,2 @@
+var x=Object.create;var l=Object.defineProperty;var y=Object.getOwnPropertyDescriptor;var S=Object.getOwnPropertyNames;var b=Object.getPrototypeOf,h=Object.prototype.hasOwnProperty;var v=(t,e)=>{for(var n in e)l(t,n,{get:e[n],enumerable:!0})},m=(t,e,n,c)=>{if(e&&typeof e=="object"||typeof e=="function")for(let s of S(e))!h.call(t,s)&&s!==n&&l(t,s,{get:()=>e[s],enumerable:!(c=y(e,s))||c.enumerable});return t};var w=(t,e,n)=>(n=t!=null?x(b(t)):{},m(e||!t||!t.__esModule?l(n,"default",{value:t,enumerable:!0}):n,t)),C=t=>m(l({},"__esModule",{value:!0}),t);var O={};v(O,{Config:()=>D,apply:()=>M,name:()=>W});module.exports=C(O);var o=require("koishi"),r=require("fs"),f=require("path"),d=require("@q78kg/mint-filter"),u=w(require("@koishijs/censor")),W="text-censor",D=o.Schema.intersect([o.Schema.object({textDatabase:o.Schema.array(o.Schema.tuple([o.Schema.string().default("data/text-censor/censor.txt")])).description("\u654F\u611F\u8BCD\u5E93\u7684\u6587\u4EF6\u8DEF\u5F84\u3002").default([["data/text-censor/censor.txt"]])}),o.Schema.object({removeWords:o.Schema.boolean().description("\u662F\u5426\u76F4\u63A5\u5220\u9664\u654F\u611F\u8BCD\u3002").default(!1),caseStrategy:o.Schema.union(["none","lower","capital"]).description("\u654F\u611F\u8BCD\u5904\u7406\u65F6\u7684\u5927\u5C0F\u5199\u7B56\u7565\u3002").default("none")})]);function M(t,e){let n=[];for(let[p]of e.textDatabase){let a=(0,f.resolve)(t.baseDir,p);if(!(0,r.existsSync)(a)){t.logger.warn(`dictionary file not found: ${a}, creating a new one.`);let i=(0,f.dirname)(a);(0,r.existsSync)(i)||(0,r.mkdirSync)(i,{recursive:!0}),(0,r.writeFileSync)(a,"")}let g=(0,r.readFileSync)(a,"utf8").split(`
+`).map(i=>i.trim()).filter(i=>i&&!i.startsWith("//")&&!i.startsWith("#"));n=n.concat(g)}if(n.length===0){t.logger.warn("no sensitive words found");return}let c={transform:e.caseStrategy,remove:e.removeWords},s=new d.Mint(n,c);t.plugin(u.default),t.get("censor").intercept({async text(p){return[s.filter(p.content).text]}})}0&&(module.exports={Config,apply,name});

package/lib/index.d.ts

@@ -1,9 +1,12 @@
-import { Context, Schema } from 'koishi';
-export declare const name = "text-censor";
-export interface Config {
+import { Schema, Context } from 'koishi';
+
+declare const name = "text-censor";
+interface Config {
     textDatabase: [string][];
     removeWords: boolean;
-    transformToUpper: boolean;
+    caseStrategy: 'capital' | 'none' | 'lower';
 }
-export declare const Config: Schema<Config>;
-export declare function apply(ctx: Context, config: Config): void;
+declare const Config: Schema<Config>;
+declare function apply(ctx: Context, config: Config): void;
+
+export { Config, apply, name };

package/lib/index.mjs

@@ -0,0 +1,2 @@
+import{Schema as e}from"koishi";import{existsSync as a,mkdirSync as p,readFileSync as m,writeFileSync as d}from"fs";import{dirname as u,resolve as g}from"path";import{Mint as x}from"@q78kg/mint-filter";import y from"@koishijs/censor";var M="text-censor",O=e.intersect([e.object({textDatabase:e.array(e.tuple([e.string().default("data/text-censor/censor.txt")])).description("\u654F\u611F\u8BCD\u5E93\u7684\u6587\u4EF6\u8DEF\u5F84\u3002").default([["data/text-censor/censor.txt"]])}),e.object({removeWords:e.boolean().description("\u662F\u5426\u76F4\u63A5\u5220\u9664\u654F\u611F\u8BCD\u3002").default(!1),caseStrategy:e.union(["none","lower","capital"]).description("\u654F\u611F\u8BCD\u5904\u7406\u65F6\u7684\u5927\u5C0F\u5199\u7B56\u7565\u3002").default("none")})]);function j(o,i){let r=[];for(let[s]of i.textDatabase){let n=g(o.baseDir,s);if(!a(n)){o.logger.warn(`dictionary file not found: ${n}, creating a new one.`);let t=u(n);a(t)||p(t,{recursive:!0}),d(n,"")}let f=m(n,"utf8").split(`
+`).map(t=>t.trim()).filter(t=>t&&!t.startsWith("//")&&!t.startsWith("#"));r=r.concat(f)}if(r.length===0){o.logger.warn("no sensitive words found");return}let c={transform:i.caseStrategy,remove:i.removeWords},l=new x(r,c);o.plugin(y),o.get("censor").intercept({async text(s){return[l.filter(s.content).text]}})}export{O as Config,j as apply,M as name};

package/package.json

@@ -1,13 +1,17 @@
 {
   "name": "@q78kg/koishi-plugin-text-censor",
   "description": "A text censor provider for Koishi",
-  "version": "1.0.4-beta.9",
+  "version": "1.0.9",
   "main": "lib/index.js",
-  "typings": "lib/index.d.ts",
   "files": [
     "lib"
   ],
   "license": "MIT",
+  "scripts": {
+    "build": "node esbuild.config.mjs && tsc --emitDeclarationOnly && rollup -c rollup.config.mjs",
+    "lint": "eslint src",
+    "lint-fix": "eslint src --fix"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Hoshino-Yumetsuki/koishi-plugin-text-censor.git"
@@ -15,7 +19,7 @@
   "bugs": {
     "url": "https://github.com/Hoshino-Yumetsuki/koishi-plugin-text-censor/issues"
   },
-  "homepage": "https://censor.koishi.chat/plugins/text.html",
+  "homepage": "https://github.com/Hoshino-Yumetsuki/koishi-plugin-text-censor",
   "keywords": [
     "bot",
     "chatbot",
@@ -33,18 +37,34 @@
       ]
     },
     "description": {
-      "en": "Filter out sensitive words in text messages",
-      "zh": "文本敏感词过滤"
+      "zh": "文本敏感词过滤服务，支持多敏感词库"
     }
   },
   "peerDependencies": {
     "koishi": "^4.17.9"
   },
   "devDependencies": {
-    "koishi": "^4.17.9"
+    "@rollup/plugin-multi-entry": "^6.0.1",
+    "@types/node": "^20.11.30",
+    "esbuild": "^0.18.20",
+    "esbuild-register": "^3.5.0",
+    "eslint": "^9.12.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-config-standard": "^17.1.0",
+    "eslint-plugin-import": "^2.30.0",
+    "eslint-plugin-n": "^16.6.2",
+    "eslint-plugin-prettier": "^5.2.1",
+    "eslint-plugin-promise": "^7.1.0",
+    "koishi": "^4.17.9",
+    "prettier": "^3.3.3",
+    "rollup": "^4.28.1",
+    "rollup-plugin-delete": "^2.1.0",
+    "rollup-plugin-dts": "^6.1.1",
+    "typescript": "^5.5.3",
+    "yml-register": "^1.2.5"
   },
   "dependencies": {
     "@koishijs/censor": "^1.0.1",
-    "mint-filter": "^3.0.1"
+    "@q78kg/mint-filter": "^4.0.6"
   }
 }

package/lib/index.js

@@ -1,107 +0,0 @@
-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_mint_filter = __toESM(require("mint-filter"));
-var import_censor = __toESM(require("@koishijs/censor"));
-var name = "text-censor";
-var Config = import_koishi.Schema.intersect([
-  import_koishi.Schema.object({
-    textDatabase: import_koishi.Schema.array(
-      import_koishi.Schema.tuple([
-        import_koishi.Schema.string().default("data/text-censor/censor.txt")
-      ])
-    ).description("敏感词库的文件路径。").default([["data/text-censor/censor.txt"]])
-  }),
-  import_koishi.Schema.object({
-    removeWords: import_koishi.Schema.boolean().description("是否直接删除敏感词。").default(false),
-    // 默认不删除敏感词
-    transformToUpper: import_koishi.Schema.boolean().description("是否将字符转换为大写。").default(false)
-    // 默认不转换字符为大写
-  })
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-]);
-function apply(ctx, config) {
-  let words = [];
-  for (const [file] of config.textDatabase) {
-    const filePath = (0, import_node_path.resolve)(ctx.baseDir, file);
-    if (!(0, import_node_fs.existsSync)(filePath)) {
-      ctx.logger.warn(
-        `dictionary file not found: ${filePath}, creating a new one.`
-      );
-      (0, import_node_fs.writeFileSync)(filePath, "");
-    }
-    const source = (0, import_node_fs.readFileSync)(filePath, "utf8");
-    const fileWords = source.split("\n").map((word) => word.trim()).filter(
-      (word) => word && !word.startsWith("//") && !word.startsWith("#")
-    );
-    words = words.concat(fileWords);
-  }
-  if (words.length === 0) {
-    ctx.logger.warn("no sensitive words found");
-    return;
-  }
-  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 originalText = attrs.content;
-      const result = await filter.filter(originalText);
-      if (typeof result.text !== "string")
-        return [];
-      if (config.removeWords) {
-        const cleanedText = result.text.replace(/\*/g, "");
-        return [cleanedText.trim()];
-      } else {
-        return [result.text];
-      }
-    }
-  });
-}
-__name(apply, "apply");
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  Config,
-  apply,
-  name
-});