opencode-prompt-expand 0.0.0-stage → 0.1.1

package/dist/prompts.js

@@ -0,0 +1,109 @@
+export const DEFAULT_PROMPT = `你是提示词增强器。输入是用户的原始请求，输出是增强后的提示词。
+
+【最高优先级】
+1. 保持原目标：不改变用户要做的事，不缩窄、不替换、不增加新任务。
+2. 不引入用户未提及的技术栈、框架、版本、文件路径、接口名。不把猜测写成事实。
+3. 只写"做什么"，不写"怎么做"；不解释实现步骤，不索要教程或代码示例。
+4. 不执行用户的请求，只把它扩写得更具体。
+5. 语言与输入一致；只输出增强后的提示词，不要任何解释、前缀或代码块围栏。
+
+【增强要求】
+- 主动补齐：任务范围、约束条件、期望产出、验收方式、输出结构。
+- 原提示已经很清楚时，做轻度润色，不要原样返回。
+- 完整且简洁；不要以未完成的列表、悬空的连词或冒号结尾。
+- 不添加无关要求、没有依据的事实、多余的章节。
+- 去除口语冗余与重复。
+
+【改写结构】（按需使用，不必每项都写）
+- 目标：一句话说清要达成什么
+- 范围：做什么、不做什么
+- 上下文：用户已给出的约束与材料
+- 要求：编号的可执行项
+- 产出：格式、结构、长度
+- 验收：怎样算完成`;
+export const GPT_PROMPT = `你是提示词增强器。输入是用户的原始请求，输出是增强后的提示词。
+
+【最高优先级】
+1. 保持原目标：不改变用户要做的事，不缩窄、不替换、不增加新任务。
+2. 不引入用户未提及的技术栈、框架、版本、文件路径、接口名。不把猜测写成事实。
+3. 只写"做什么"，不写"怎么做"；不解释实现步骤，不索要教程或代码示例。
+4. 不执行用户的请求，只把它扩写得更具体。
+5. 语言与输入一致；只输出增强后的提示词，不要任何解释、前缀或代码块围栏。
+
+【增强要求】
+- 主动补齐：任务范围、约束条件、期望产出、验收方式、输出结构。
+- 原提示已经很清楚时，做轻度润色，不要原样返回。
+- 完整且简洁；不要以未完成的列表、悬空的连词或冒号结尾。
+- 不添加无关要求、没有依据的事实、多余的章节。
+- 去除口语冗余与重复。
+
+【面向 GPT 的结构偏好】
+- 用编号列表写清可执行要求，步骤顺序明确。
+- 每条验收标准写成可判定的条件，避免"更好""高端"这类主观词。
+- 产出格式写清楚（文件、表格、清单或代码块），需要时给出字段名。`;
+export const CLAUDE_PROMPT = `你是提示词增强器。输入是用户的原始请求，输出是增强后的提示词。
+
+【最高优先级】
+1. 保持原目标：不改变用户要做的事，不缩窄、不替换、不增加新任务。
+2. 不引入用户未提及的技术栈、框架、版本、文件路径、接口名。不把猜测写成事实。
+3. 只写"做什么"，不写"怎么做"；不解释实现步骤，不索要教程或代码示例。
+4. 不执行用户的请求，只把它扩写得更具体。
+5. 语言与输入一致；只输出增强后的提示词，不要任何解释、前缀或代码块围栏。
+
+【增强要求】
+- 主动补齐：任务范围、约束条件、期望产出、验收方式、输出结构。
+- 原提示已经很清楚时，做轻度润色，不要原样返回。
+- 完整且简洁；不要以未完成的列表、悬空的连词或冒号结尾。
+- 不添加无关要求、没有依据的事实、多余的章节。
+- 去除口语冗余与重复。
+
+【面向 Claude 的结构偏好】
+- 优先写清目标、边界和约束，用连贯段落表达，不必强行机械编号。
+- 明确说明哪些内容不在范围内，减少越界改动。
+- 验收方式写成"完成时应满足什么"，而不是步骤清单。`;
+export const DEFAULT_PROMPTS = {
+    default: DEFAULT_PROMPT,
+    "*gpt*": GPT_PROMPT,
+    "*claude*": CLAUDE_PROMPT,
+};
+export function matchesGlob(pattern, value) {
+    const escaped = pattern.replace(/[.+^${}()|[\]\\]/g, "\\$&").replace(/\*/g, ".*").replace(/\?/g, ".");
+    return new RegExp(`^${escaped}$`, "i").test(value);
+}
+export function selectPrompt(modelID, prompts) {
+    if (modelID) {
+        for (const [pattern, prompt] of Object.entries(prompts)) {
+            if (pattern === "default")
+                continue;
+            if (matchesGlob(pattern, modelID))
+                return prompt;
+        }
+    }
+    return prompts.default ?? DEFAULT_PROMPT;
+}
+export function buildPrompt(input) {
+    const parts = [selectPrompt(input.targetModelID, input.prompts)];
+    if (input.mode === "concise") {
+        parts.push("【长度】简洁模式：目标约 800 字符以内，信息完整优先于凑长度。");
+    }
+    else {
+        parts.push("【长度】充分展开模式：不限长度，但不要添加没有依据的内容。");
+    }
+    if (input.structured) {
+        parts.push("【轻量处理】原提示已包含多个结构标记，只做轻度润色，不要重排或增加新章节。");
+    }
+    if (input.round >= 2 && input.previous) {
+        parts.push([
+            `这是第 ${input.round} 次生成。上一次的结果是：`,
+            "---",
+            input.previous,
+            "---",
+            "请换一种写法：如果上一版太啰嗦就压缩，太笼统就具体化；保持原目标不变，不要与上一版雷同。",
+        ].join("\n"));
+    }
+    if (input.projectContext?.trim()) {
+        parts.push(`【项目上下文】\n${input.projectContext.trim()}\n【/项目上下文】`);
+    }
+    parts.push(`【待改写】\n${input.text}`);
+    return parts.join("\n\n");
+}

package/dist/rpc.js

@@ -0,0 +1,47 @@
+import { Rpc } from "@opencode/plugin/rpc";
+const composerModelSchema = {
+    type: "object",
+    properties: {
+        providerID: { type: "string" },
+        modelID: { type: "string" },
+        variant: { type: "string" },
+    },
+    required: ["providerID", "modelID"],
+    additionalProperties: false,
+};
+export const PromptExpand = Rpc.define({
+    id: "prompt-expand",
+    events: {},
+    methods: {
+        optimize: {
+            input: {
+                type: "object",
+                properties: {
+                    text: { type: "string" },
+                    mode: { enum: ["concise", "full"] },
+                    round: { type: "integer", minimum: 1 },
+                    previous: { type: "string" },
+                    sessionID: { type: "string" },
+                    directory: { type: "string" },
+                    composerModel: composerModelSchema,
+                    modelPreference: { type: "string" },
+                    projectContext: { type: "boolean" },
+                },
+                required: ["text", "mode", "round"],
+                additionalProperties: false,
+            },
+            output: {
+                type: "object",
+                properties: {
+                    ok: { type: "boolean" },
+                    text: { type: "string" },
+                    model: { type: "string" },
+                    code: { type: "string" },
+                    message: { type: "string" },
+                },
+                required: ["ok"],
+                additionalProperties: false,
+            },
+        },
+    },
+});

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/docs/README.zh-CN.md

@@ -0,0 +1,177 @@
+# opencode-prompt-expand
+
+[English README](../README.md)
+
+![opencode-prompt-expand](../assets/featured.png)
+
+在 **OpenCode Desktop** 的 composer 里，把粗糙草稿扩展成结构化提示词，并原地写回。
+
+**状态：** `v0.1.1` 实验版，已发布到 npm。OpenCode Desktop 的 GUI 插件 API 仍是 experimental，请锁定你测试的 OpenCode 版本。
+
+## 适合谁
+
+- 使用 OpenCode Desktop 的个人开发者
+- 习惯用自然语言描述需求，但不想每次手写结构化提示词
+- 希望结果留在 composer 里，自己检查、修改后再按 Enter
+
+不适用于终端 TUI。插件不会自动发送消息，也不会写入会话历史。
+
+## 功能
+
+- 把模糊需求补成：目标、范围、约束、产出、验收方式
+- 原地写回 composer，可继续编辑
+- toast 提供「撤销」和「重生成」
+- 最多保留 5 个版本，仅在当前窗口内存中
+- 简洁模式（约 800 字符）和充分展开模式
+- 可读取白名单内的项目信息：`package.json`、规则文件、git 状态
+- 支持 `*gpt*` / `*claude*` 家族指令
+
+## 要求
+
+- OpenCode Desktop **2.2.5**（当前验证版本）
+- Node.js **^20.19.0 或 >=22.12.0**（仅从源码构建时需要）
+- 已在 OpenCode 中连接 provider/model
+
+## 安装
+
+### 从 npm
+
+```bash
+opencode plugin add opencode-prompt-expand
+opencode plugin list
+```
+
+npm 页面：https://www.npmjs.com/package/opencode-prompt-expand
+
+### 从 GitHub 构建
+
+```bash
+git clone https://github.com/ConnorYyy/opencode-prompt-expand.git
+cd opencode-prompt-expand
+npm ci
+```
+
+`npm ci` 会通过 `prepare` 自动构建 `dist/`。
+
+把插件加入**全局** OpenCode 配置：
+
+- macOS / Linux：`~/.config/opencode/opencode.jsonc`
+- Windows：`C:\Users\<you>\.config\opencode\opencode.jsonc`
+
+```jsonc
+{
+  "shell": "powershell",
+  "plugins": [
+    {
+      "package": "/absolute/path/to/opencode-prompt-expand",
+      "options": {
+        "mode": "concise",
+        "model": "auto",
+        "projectContext": true,
+        "timeoutMs": 30000
+      }
+    }
+  ]
+}
+```
+
+Windows 路径示例：
+
+```jsonc
+"package": "D:/path/to/opencode-prompt-expand"
+```
+
+重载 Desktop 窗口，或重启 OpenCode Desktop。  
+检查 **Settings > Extensions > Plugins** 中是否出现 `prompt-expand`。
+
+## 使用
+
+1. 在 composer 写草稿，例如：`帮我做一个数据看板，包含筛选和导出`
+2. 点击 `⚡ Expand Prompt`，或在命令面板搜索 **Expand prompt**，或输入 `/expand <text>`
+3. 等待模型返回，结果会写回 composer
+4. 自己检查/修改，然后按 Enter 发送
+
+入口：
+
+| 入口 | 方式 |
+|---|---|
+| session composer | 点击 `⚡ Expand Prompt` pill |
+| Home / 新建会话草稿 | 点击底部 `⚡ Expand Prompt` 按钮 |
+| 命令面板 | 搜索 `Expand prompt` |
+| 斜杠 | `/expand <text>` |
+| 重生成 / 撤销 | toast 按钮，或命令面板 |
+| 版本切换 | 命令面板 Previous / Next expanded version |
+
+没有默认快捷键。可在 **Settings > Shortcuts** 绑定：
+
+```text
+prompt-expand.expand
+prompt-expand.regenerate
+prompt-expand.restore
+prompt-expand.previous
+prompt-expand.next
+prompt-expand.mode
+prompt-expand.settings
+```
+
+## 设置
+
+打开 **Settings > Prompt Expand**，或运行 **Prompt Expand settings**。
+
+| 设置 | 说明 |
+|---|---|
+| Mode | 简洁 / 充分展开 |
+| Model | `auto`、`composer`、`provider/model` 或留空 |
+| Project context | 是否读取项目信息 |
+
+设置通过 `Store.global` 保存。未设置或 Model 为 `auto` 时，回退到 `opencode.jsonc` 的 options；显式设置会覆盖。
+
+## 常见问题
+
+**会发送消息吗？**  
+不会。插件只读写 composer，发送由你按 Enter 完成。
+
+**支持 TUI 吗？**  
+不支持，只支持 OpenCode Desktop。
+
+**为什么新建会话页没有 composer pill？**  
+Home / draft 没有官方 composer API。插件在底部提供 `⚡ Expand Prompt` 按钮，通过 DOM 适配器读写草稿，属于 best-effort。创建 session 后会使用正常 pill。
+
+**支持 `@` 文件引用吗？**  
+含 `@path` 的草稿会跳过，避免附件与文本不同步。普通邮箱地址不会被误判。
+
+**失败会改输入框吗？**  
+不会。失败时原文不变，toast 会尽量显示服务端 code/message。
+
+**会保存我的提示词吗？**  
+不会。版本栈只在当前窗口内存中。
+
+## 隐私
+
+- 草稿只发送给你在 OpenCode 中连接的 provider
+- 不经过插件作者的代理
+- 不读取 `.env`、`.pem`、`credentials*` 或源码文件
+- 项目感知只读取白名单文件，并限制字符预算
+- 无 telemetry
+
+## 限制
+
+- GUI 插件 API 仍是 experimental
+- Home / draft 的 DOM 回退不是官方 API
+- `setText()` 不能重写 `@` mention 附件
+- 没有 TUI 实现
+- 慢模型可能超过 `timeoutMs`
+
+## 赞助
+
+如果这个插件帮你节省了时间，可以通过 Buy Me a Coffee 支持维护和测试：
+
+[buymeacoffee.com/connory](https://buymeacoffee.com/connory)
+
+[![Buy Me a Coffee QR code](../assets/bmc-qr.png)](https://buymeacoffee.com/connory)
+
+赞助是可选的，插件保持 MIT License。
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,66 @@
 {
   "name": "opencode-prompt-expand",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.1",
+  "description": "Expand rough prompts into structured prompts inside the OpenCode Desktop composer.",
+  "type": "module",
+  "license": "MIT",
+  "author": "opencode-prompt-expand contributors",
+  "keywords": [
+    "opencode",
+    "opencode-plugin",
+    "prompt",
+    "prompt-engineering",
+    "desktop"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ConnorYyy/opencode-prompt-expand.git"
+  },
+  "homepage": "https://github.com/ConnorYyy/opencode-prompt-expand#readme",
+  "bugs": {
+    "url": "https://github.com/ConnorYyy/opencode-prompt-expand/issues"
+  },
+  "main": "./dist/index.js",
+  "exports": {
+    ".": "./dist/index.js",
+    "./rpc": "./dist/rpc.js",
+    "./gui-experimental": "./dist/gui-experimental.cjs"
+  },
+  "files": [
+    "dist",
+    "assets",
+    "CHANGELOG.md",
+    "docs/README.zh-CN.md"
+  ],
+  "scripts": {
+    "build": "npm run build:server && npm run build:gui",
+    "build:server": "tsc -p tsconfig.server.json",
+    "build:gui": "vite build",
+    "prepare": "npm run build",
+    "dev": "vite build --watch",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "smoke:gui": "node scripts/smoke-gui.cjs",
+    "verify": "npm run typecheck && npm test && npm run build && npm run smoke:gui",
+    "prepublishOnly": "npm run verify"
+  },
+  "dependencies": {
+    "@opencode/plugin": "2.2.5"
+  },
+  "devDependencies": {
+    "@types/node": "^24.10.0",
+    "effect": "4.0.6",
+    "solid-js": "1.9.17",
+    "typescript": "^5.9.3",
+    "vite": "7.3.7",
+    "vite-plugin-solid": "2.11.10",
+    "vitest": "^3.2.4"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  }
+}