kokkoro-plugin-eval 1.0.0 → 1.0.3

package/README.md

@@ -1,6 +1,6 @@
 # kokkoro-plugin-eval
 
-在聊天中执行 JavaScript 或 TypeScript 代码。
+代码执行，运行 JavaScript 或 TypeScript 代码并返回执行结果。
 
 ## 安装
 
@@ -11,13 +11,13 @@ bun add kokkoro-plugin-eval
 ## 指令
 
 ```text
-/执行 <parts>...
+/执行 <code>
 ```
 
-`parts` 表示需要执行的代码。发送指令后，插件会返回执行结果。
+`code` 表示需要执行的代码。发送指令后，插件会返回执行结果。
 
 ```text
-/执行 1 + 1
+/执行 0.1 + 0.2
 ```
 
 ## 快捷方式
@@ -28,17 +28,27 @@ bun add kokkoro-plugin-eval
 > await fetch('https://example.com').then(response => response.status)
 ```
 
-群聊需要开启「获取群内全部消息」权限。
+要让普通群消息触发快捷方式，需要开启「获取群内全部消息」权限。
 
-## 环境变量
+## API
 
-`EVAL_TIMEOUT` 和 `EVAL_MAX_BUFFER` 用于自定义插件的执行超时时间和输出上限，单位分别为毫秒和字节。默认值如下：
+其他插件可以从 `service` 入口导入 `evaluate()`，在独立的 Bun 子进程中执行代码：
 
-```ini
-EVAL_TIMEOUT=60000
-EVAL_MAX_BUFFER=65536
+```typescript
+import { evaluate } from 'kokkoro-plugin-eval/service';
+
+const output = await evaluate('0.1 + 0.2');
 ```
 
 ## 安全
 
-建议只允许可信用户使用该插件。执行的代码拥有与 Kokkoro 进程相同的系统权限，可以读取文件和环境变量，也可以执行系统命令。
+建议只允许可信用户使用该插件。代码在子进程中执行，不继承 Kokkoro 主进程的环境变量，但拥有相同的系统权限，可以读取文件和执行系统命令。
+
+## 环境变量
+
+`EVAL_TIMEOUT` 和 `EVAL_MAX_BUFFER` 用于自定义插件的执行超时时间和输出上限，单位分别为毫秒和字节。默认值如下：
+
+```ini
+EVAL_TIMEOUT=10000
+EVAL_MAX_BUFFER=32768
+```

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "kokkoro-plugin-eval",
-  "version": "1.0.0",
-  "description": "在聊天中执行 JavaScript 或 TypeScript 代码",
+  "version": "1.0.3",
+  "description": "代码执行，运行 JavaScript 或 TypeScript 代码并返回执行结果。",
   "keywords": [
     "bot",
     "kokkoro",
@@ -17,12 +17,15 @@
   "license": "MIT",
   "author": "Yuki <admin@yuki.sh>",
   "type": "module",
-  "exports": "./src/index.ts",
+  "exports": {
+    ".": "./src/index.ts",
+    "./service": "./src/service.ts"
+  },
   "files": [
     "src"
   ],
   "peerDependencies": {
-    "@kokkoro/core": "^3.1.3",
+    "@kokkoro/core": "^3.1.4",
     "typescript": "^6.0.3"
   }
 }

package/src/index.ts

@@ -1,36 +1,20 @@
-import { spawn } from 'bun';
+import { useCommand, useLogger } from '@kokkoro/core';
 
-import { useCommand } from '@kokkoro/core';
+import { evaluate } from './service';
 
-const { EVAL_TIMEOUT: TIMEOUT = 1000 * 60, EVAL_MAX_BUFFER: MAX_BUFFER = 1024 * 64 } = import.meta.env;
+const logger = useLogger();
 
-async function execute(parts: string[]) {
-  const source = parts.join(' ');
-  const signal = AbortSignal.timeout(Number(TIMEOUT));
-  const subprocess = spawn(['bun', '--print', source], {
-    stderr: 'pipe',
-    signal,
-    killSignal: 'SIGKILL',
-    maxBuffer: Number(MAX_BUFFER),
-  });
-  const [stdout, stderr, exitCode] = await Promise.all([
-    subprocess.stdout.text(),
-    subprocess.stderr.text(),
-    subprocess.exited,
-  ]);
+export default () => {
+  useCommand('/执行 <code>', async context => {
+    const source = context.trigger === 'shortcut' ? context.args.code : context.content.replace(/^.*?\/执行\s+/s, '');
 
-  if (signal.aborted) {
-    throw new Error('代码执行超时');
-  }
+    logger.debug('开始执行代码', { source });
 
-  if (exitCode) {
-    throw new Error(stderr.trim() || `代码执行失败，退出码 ${exitCode}`);
-  }
-  return [stdout.trim(), stderr.trim()].filter(Boolean).join('\n') || undefined;
-}
+    const output = await evaluate(source);
 
-export default () => {
-  useCommand('/执行 <parts>...', context => {
-    return execute(context.args.parts);
-  }).shortcut(/^>\s*(?<parts>.+)$/s);
+    logger.debug('代码执行结果', { output });
+    logger.info('已执行代码');
+
+    return output;
+  }).shortcut(/^>\s*(?<code>.+)$/s);
 };

package/src/service.ts

@@ -0,0 +1,29 @@
+import { spawn } from 'bun';
+
+const { EVAL_TIMEOUT: TIMEOUT = 10000, EVAL_MAX_BUFFER: MAX_BUFFER = 1024 * 32 } = import.meta.env;
+
+/** 在独立的 Bun 子进程中执行代码，并返回标准输出和错误输出。 */
+export async function evaluate(source: string): Promise<string | undefined> {
+  const signal = AbortSignal.timeout(Number(TIMEOUT));
+  const subprocess = spawn([process.execPath, '--no-env-file', '--print', source], {
+    env: {},
+    stderr: 'pipe',
+    signal,
+    killSignal: 'SIGKILL',
+    maxBuffer: Number(MAX_BUFFER),
+  });
+  const [stdout, stderr, exitCode] = await Promise.all([
+    subprocess.stdout.text(),
+    subprocess.stderr.text(),
+    subprocess.exited,
+  ]);
+
+  if (signal.aborted) {
+    throw new Error('代码执行超时');
+  }
+
+  if (exitCode) {
+    throw new Error(stderr.trim() || `代码执行失败，退出码 ${exitCode}`);
+  }
+  return [stdout.trim(), stderr.trim()].filter(Boolean).join('\n') || undefined;
+}