@zhin.js/plugin-code-runner 1.1.3 → 1.1.5

package/README.md

@@ -5,24 +5,30 @@ Zhin.js plugin for code-runner functionality.
 ## Installation
 
 ```bash
-pnpm add @zhin.js/plugin-code-runner
+pnpm exec zhin install @zhin.js/plugin-code-runner
 ```
 
 ## Usage
 
-Add the plugin to your `zhin.config.yml`:
+Run the installation command from your application directory. It installs the package and mounts the `code-runner` instance in `package.json#zhin.plugins`. The corresponding `zhin.config.yml` node is:
 
 ```yaml
 plugins:
-  - @zhin.js/plugin-code-runner
+  code-runner: {}
 ```
 
-Or via CLI:
+## Configuration
 
-```bash
-zhin install @zhin.js/plugin-code-runner
-```
+This plugin currently has no configuration fields. Its [`schema.json`](./schema.json) accepts an empty object; do not place package names in a `plugins` array.
 
-## Configuration
+## Commands
+
+- `run javascript console.log("hello")`: execute with the default 30-second timeout.
+- `run python --timeout 5 print(1)` / `run python -t 5 print(1)`: choose 1–30 seconds.
+- `run --help`: show supported languages, code constraints and timeout defaults.
 
-Configure in `zhin.config.yml` under the plugin's key. Refer to the plugin source for available options.
+The Endpoint determines any command prefix, and an explicit `commandNamespace` adds a plugin
+namespace. `commands/run/[language]/index.ts` binds the language, while code and timeout are
+centrally declared in the same definition. Code keeps quotes and newlines; its limit is
+10,000 characters. Use `--` before code containing option-like words. Unsupported languages,
+missing code and invalid timeout values are rejected before the remote request.

package/commands/run/[language]/index.js

@@ -1,16 +1,17 @@
 // Generated by build-plugin-runtime-entries.mjs. Do not edit.
 import { defineCommand } from 'zhin.js/command';
-import { formatResult, runCode } from "../../../lib/run-code.js";
+import { formatResult, MAX_CODE_LENGTH, runCode, supportedLanguages } from "../../../lib/run-code.js";
 export default defineCommand({
-    description: '在沙箱中运行代码片段（/code-runner run <语言> <代码>）',
-    params: { language: { type: 'string' } },
-    async execute({ params, args }) {
-        const language = String(params.language ?? '');
-        // code 原来是第二动态段，约定式命令只支持单动态文件参数，改从 args 取
-        const code = args.join(' ').trim();
-        if (!code)
-            return '请提供要运行的代码，例如：/code-runner run javascript alert(1+1)';
-        const result = await runCode(language, code);
-        return formatResult(result);
+    description: '在远程沙箱中运行代码片段',
+    params: {
+        language: {
+            type: 'string', description: `执行语言：${supportedLanguages.join(', ')}（不区分大小写）`,
+            validate: (value) => typeof value === 'string' && supportedLanguages.includes(value.toLowerCase().trim()),
+        },
+        code: { type: 'text', min: 1, max: MAX_CODE_LENGTH, description: '要运行的代码' },
+    },
+    options: { timeout: { type: 'integer', alias: 't', default: 30, min: 1, max: 30, description: '请求超时（秒）' } },
+    async execute({ params, options }) {
+        return formatResult(await runCode(params.language, params.code, options.timeout));
     },
 });

package/commands/run/[language]/index.ts

@@ -1,15 +1,17 @@
-import { defineCommand } from 'zhin.js/command';
-import { formatResult, runCode } from '../../../src/run-code.js';
+import { defineCommand, type CommandParameterValue } from 'zhin.js/command';
+import { formatResult, MAX_CODE_LENGTH, runCode, supportedLanguages } from '../../../src/run-code.js';
 
 export default defineCommand({
-  description: '在沙箱中运行代码片段（/code-runner run <语言> <代码>）',
-  params: { language: { type: 'string' } },
-  async execute({ params, args }) {
-    const language = String(params.language ?? '');
-    // code 原来是第二动态段，约定式命令只支持单动态文件参数，改从 args 取
-    const code = args.join(' ').trim();
-    if (!code) return '请提供要运行的代码，例如：/code-runner run javascript alert(1+1)';
-    const result = await runCode(language, code);
-    return formatResult(result);
+  description: '在远程沙箱中运行代码片段',
+  params: {
+    language: {
+      type: 'string', description: `执行语言：${supportedLanguages.join(', ')}（不区分大小写）`,
+      validate: (value: CommandParameterValue) => typeof value === 'string' && supportedLanguages.includes(value.toLowerCase().trim()),
+    },
+    code: { type: 'text', min: 1, max: MAX_CODE_LENGTH, description: '要运行的代码' },
+  },
+  options: { timeout: { type: 'integer', alias: 't', default: 30, min: 1, max: 30, description: '请求超时（秒）' } },
+  async execute({ params, options }) {
+    return formatResult(await runCode(params.language, params.code, options.timeout));
   },
 });

package/lib/run-code.d.ts

@@ -1,9 +1,11 @@
+export declare const MAX_CODE_LENGTH = 10000;
+export declare const supportedLanguages: readonly string[];
 interface RunResult {
     stdout: string;
     stderr: string;
     error: string;
 }
-export declare function runCode(language: string, code: string): Promise<RunResult>;
+export declare function runCode(language: string, code: string, timeoutSeconds?: number): Promise<RunResult>;
 export declare function formatResult(result: RunResult): string;
 export {};
 //# sourceMappingURL=run-code.d.ts.map

package/lib/run-code.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"run-code.d.ts","sourceRoot":"","sources":["../src/run-code.ts"],"names":[],"mappings":"AAiBA,UAAU,SAAS;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACf;AAED,wBAAsB,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAmDhF;AAED,wBAAgB,YAAY,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM,CAMtD"}
+{"version":3,"file":"run-code.d.ts","sourceRoot":"","sources":["../src/run-code.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,eAAe,QAAQ,CAAC;AAerC,eAAO,MAAM,kBAAkB,mBAAkD,CAAC;AAIlF,UAAU,SAAS;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACf;AAED,wBAAsB,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,cAAc,SAAK,GAAG,OAAO,CAAC,SAAS,CAAC,CAmDrG;AAED,wBAAgB,YAAY,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM,CAMtD"}

package/lib/run-code.js

@@ -1,4 +1,4 @@
-const MAX_CODE_LENGTH = 10000;
+export const MAX_CODE_LENGTH = 10000;
 const SUPPORTED_LANGUAGES = {
     python: 'main.py',
     javascript: 'main.js',
@@ -11,8 +11,9 @@ const SUPPORTED_LANGUAGES = {
     ruby: 'main.rb',
     php: 'main.php',
 };
+export const supportedLanguages = Object.freeze(Object.keys(SUPPORTED_LANGUAGES));
 const GLOT_API_BASE = 'https://glot.io/api/run';
-export async function runCode(language, code) {
+export async function runCode(language, code, timeoutSeconds = 30) {
     const lang = language.toLowerCase().trim();
     if (!SUPPORTED_LANGUAGES[lang]) {
         return {
@@ -37,7 +38,7 @@ export async function runCode(language, code) {
             body: JSON.stringify({
                 files: [{ name: fileName, content: code }],
             }),
-            signal: AbortSignal.timeout(30_000),
+            signal: AbortSignal.timeout(timeoutSeconds * 1000),
         });
         if (!response.ok) {
             return {
@@ -55,7 +56,7 @@ export async function runCode(language, code) {
     }
     catch (e) {
         const err = e;
-        const msg = err.name === 'TimeoutError' ? '请求超时（30s）' : err.message || '未知错误';
+        const msg = err.name === 'TimeoutError' ? `请求超时（${timeoutSeconds}s）` : err.message || '未知错误';
         return { stdout: '', stderr: '', error: msg };
     }
 }

package/lib/run-code.js.map

@@ -1 +1 @@
-{"version":3,"file":"run-code.js","sourceRoot":"","sources":["../src/run-code.ts"],"names":[],"mappings":"AAAA,MAAM,eAAe,GAAG,KAAK,CAAC;AAE9B,MAAM,mBAAmB,GAA2B;IAClD,MAAM,EAAE,SAAS;IACjB,UAAU,EAAE,SAAS;IACrB,UAAU,EAAE,SAAS;IACrB,EAAE,EAAE,SAAS;IACb,IAAI,EAAE,SAAS;IACf,IAAI,EAAE,WAAW;IACjB,CAAC,EAAE,QAAQ;IACX,GAAG,EAAE,UAAU;IACf,IAAI,EAAE,SAAS;IACf,GAAG,EAAE,UAAU;CAChB,CAAC;AAEF,MAAM,aAAa,GAAG,yBAAyB,CAAC;AAQhD,MAAM,CAAC,KAAK,UAAU,OAAO,CAAC,QAAgB,EAAE,IAAY;IAC1D,MAAM,IAAI,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC;IAE3C,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/B,OAAO;YACL,MAAM,EAAE,EAAE;YACV,MAAM,EAAE,EAAE;YACV,KAAK,EAAE,WAAW,IAAI,QAAQ,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;SAC5E,CAAC;IACJ,CAAC;IAED,IAAI,IAAI,CAAC,MAAM,GAAG,eAAe,EAAE,CAAC;QAClC,OAAO;YACL,MAAM,EAAE,EAAE;YACV,MAAM,EAAE,EAAE;YACV,KAAK,EAAE,YAAY,eAAe,UAAU,IAAI,CAAC,MAAM,GAAG;SAC3D,CAAC;IACJ,CAAC;IAED,MAAM,QAAQ,GAAG,mBAAmB,CAAC,IAAI,CAAC,CAAC;IAC3C,MAAM,GAAG,GAAG,GAAG,aAAa,IAAI,IAAI,SAAS,CAAC;IAE9C,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;YAChC,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;YAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;aAC3C,CAAC;YACF,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC;SACpC,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,OAAO;gBACL,MAAM,EAAE,EAAE;gBACV,MAAM,EAAE,EAAE;gBACV,KAAK,EAAE,aAAa,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,EAAE;aAC7D,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAc,CAAC;QAClD,OAAO;YACL,MAAM,EAAE,IAAI,CAAC,MAAM,IAAI,EAAE;YACzB,MAAM,EAAE,IAAI,CAAC,MAAM,IAAI,EAAE;YACzB,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,EAAE;SACxB,CAAC;IACJ,CAAC;IAAC,OAAO,CAAU,EAAE,CAAC;QACpB,MAAM,GAAG,GAAG,CAAU,CAAC;QACvB,MAAM,GAAG,GAAG,GAAG,CAAC,IAAI,KAAK,cAAc,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,IAAI,MAAM,CAAC;QAC9E,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;IAChD,CAAC;AACH,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,MAAiB;IAC5C,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,IAAI,MAAM,CAAC,MAAM;QAAE,KAAK,CAAC,IAAI,CAAC,aAAa,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IAC5D,IAAI,MAAM,CAAC,MAAM;QAAE,KAAK,CAAC,IAAI,CAAC,aAAa,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IAC5D,IAAI,MAAM,CAAC,KAAK;QAAE,KAAK,CAAC,IAAI,CAAC,YAAY,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;IACzD,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;AACnD,CAAC"}
+{"version":3,"file":"run-code.js","sourceRoot":"","sources":["../src/run-code.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,eAAe,GAAG,KAAK,CAAC;AAErC,MAAM,mBAAmB,GAA2B;IAClD,MAAM,EAAE,SAAS;IACjB,UAAU,EAAE,SAAS;IACrB,UAAU,EAAE,SAAS;IACrB,EAAE,EAAE,SAAS;IACb,IAAI,EAAE,SAAS;IACf,IAAI,EAAE,WAAW;IACjB,CAAC,EAAE,QAAQ;IACX,GAAG,EAAE,UAAU;IACf,IAAI,EAAE,SAAS;IACf,GAAG,EAAE,UAAU;CAChB,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC;AAElF,MAAM,aAAa,GAAG,yBAAyB,CAAC;AAQhD,MAAM,CAAC,KAAK,UAAU,OAAO,CAAC,QAAgB,EAAE,IAAY,EAAE,cAAc,GAAG,EAAE;IAC/E,MAAM,IAAI,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC;IAE3C,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/B,OAAO;YACL,MAAM,EAAE,EAAE;YACV,MAAM,EAAE,EAAE;YACV,KAAK,EAAE,WAAW,IAAI,QAAQ,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;SAC5E,CAAC;IACJ,CAAC;IAED,IAAI,IAAI,CAAC,MAAM,GAAG,eAAe,EAAE,CAAC;QAClC,OAAO;YACL,MAAM,EAAE,EAAE;YACV,MAAM,EAAE,EAAE;YACV,KAAK,EAAE,YAAY,eAAe,UAAU,IAAI,CAAC,MAAM,GAAG;SAC3D,CAAC;IACJ,CAAC;IAED,MAAM,QAAQ,GAAG,mBAAmB,CAAC,IAAI,CAAC,CAAC;IAC3C,MAAM,GAAG,GAAG,GAAG,aAAa,IAAI,IAAI,SAAS,CAAC;IAE9C,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;YAChC,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;YAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;aAC3C,CAAC;YACF,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC;SACnD,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,OAAO;gBACL,MAAM,EAAE,EAAE;gBACV,MAAM,EAAE,EAAE;gBACV,KAAK,EAAE,aAAa,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,EAAE;aAC7D,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAc,CAAC;QAClD,OAAO;YACL,MAAM,EAAE,IAAI,CAAC,MAAM,IAAI,EAAE;YACzB,MAAM,EAAE,IAAI,CAAC,MAAM,IAAI,EAAE;YACzB,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,EAAE;SACxB,CAAC;IACJ,CAAC;IAAC,OAAO,CAAU,EAAE,CAAC;QACpB,MAAM,GAAG,GAAG,CAAU,CAAC;QACvB,MAAM,GAAG,GAAG,GAAG,CAAC,IAAI,KAAK,cAAc,CAAC,CAAC,CAAC,QAAQ,cAAc,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,IAAI,MAAM,CAAC;QAC7F,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;IAChD,CAAC;AACH,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,MAAiB;IAC5C,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,IAAI,MAAM,CAAC,MAAM;QAAE,KAAK,CAAC,IAAI,CAAC,aAAa,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IAC5D,IAAI,MAAM,CAAC,MAAM;QAAE,KAAK,CAAC,IAAI,CAAC,aAAa,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IAC5D,IAAI,MAAM,CAAC,KAAK;QAAE,KAAK,CAAC,IAAI,CAAC,YAAY,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;IACzD,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;AACnD,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zhin.js/plugin-code-runner",
-  "version": "1.1.3",
+  "version": "1.1.5",
   "description": "Sandboxed code execution plugin for Zhin.js (Plugin Runtime)",
   "type": "module",
   "main": "./lib/index.js",
@@ -42,12 +42,12 @@
     "typescript": "^6.0.3",
     "vitest": "^4.1.10",
     "zod": "^4.4.3",
-    "zhin.js": "1.1.5"
+    "zhin.js": "1.1.8"
   },
   "peerDependencies": {
     "zod": "^4.0.0",
-    "@zhin.js/command": "^1.1.4",
-    "zhin.js": "^1.1.5"
+    "@zhin.js/command": "^1.1.6",
+    "zhin.js": "^1.1.8"
   },
   "peerDependenciesMeta": {
     "@zhin.js/command": {
@@ -92,8 +92,8 @@
     "plugins": []
   },
   "dependencies": {
-    "@zhin.js/tool": "1.1.3",
-    "@zhin.js/skill": "1.1.3"
+    "@zhin.js/tool": "1.1.5",
+    "@zhin.js/skill": "1.1.5"
   },
   "scripts": {
     "build": "tsc",

package/src/run-code.ts

@@ -1,4 +1,4 @@
-const MAX_CODE_LENGTH = 10000;
+export const MAX_CODE_LENGTH = 10000;
 
 const SUPPORTED_LANGUAGES: Record<string, string> = {
   python: 'main.py',
@@ -13,6 +13,8 @@ const SUPPORTED_LANGUAGES: Record<string, string> = {
   php: 'main.php',
 };
 
+export const supportedLanguages = Object.freeze(Object.keys(SUPPORTED_LANGUAGES));
+
 const GLOT_API_BASE = 'https://glot.io/api/run';
 
 interface RunResult {
@@ -21,7 +23,7 @@ interface RunResult {
   error: string;
 }
 
-export async function runCode(language: string, code: string): Promise<RunResult> {
+export async function runCode(language: string, code: string, timeoutSeconds = 30): Promise<RunResult> {
   const lang = language.toLowerCase().trim();
 
   if (!SUPPORTED_LANGUAGES[lang]) {
@@ -50,7 +52,7 @@ export async function runCode(language: string, code: string): Promise<RunResult
       body: JSON.stringify({
         files: [{ name: fileName, content: code }],
       }),
-      signal: AbortSignal.timeout(30_000),
+      signal: AbortSignal.timeout(timeoutSeconds * 1000),
     });
 
     if (!response.ok) {
@@ -69,7 +71,7 @@ export async function runCode(language: string, code: string): Promise<RunResult
     };
   } catch (e: unknown) {
     const err = e as Error;
-    const msg = err.name === 'TimeoutError' ? '请求超时（30s）' : err.message || '未知错误';
+    const msg = err.name === 'TimeoutError' ? `请求超时（${timeoutSeconds}s）` : err.message || '未知错误';
     return { stdout: '', stderr: '', error: msg };
   }
 }