scroll-plugin 0.1.0

package/README.md

@@ -0,0 +1,36 @@
+# Scroll Plugin (OpenCode)
+
+Unified OpenCode plugin for Scroll that handles both prompt capture (for RLM feedback) and inline skill/prompt suggestions.
+
+## Requirements
+- Bun runtime (tested with 1.3+)
+- `scroll` CLI available in PATH (or set `SCROLL_BIN`)
+
+## Setup
+1. Copy the plugin into OpenCode plugins:
+   ```bash
+   mkdir -p ~/.config/opencode/plugin
+   cp -r scroll-plugin ~/.config/opencode/plugin/
+   ```
+2. Ensure `opencode.json` includes the plugin:
+   ```json
+   {
+     "plugin": ["scroll-plugin"],
+     "mcp": { "scroll": { "type": "local", "command": ["scroll", "mcp", "start"], "enabled": true } }
+   }
+   ```
+   (running `scroll init --opencode` will add this automatically.)
+
+## Environment
+- `SCROLL_BIN`: override scroll binary path
+- `SCROLL_SUGGEST_LIMIT`: suggestions per request (default 3)
+- `SCROLL_SUGGEST_DEBOUNCE_MS`: debounce for TUI suggestions (default 800ms)
+- `SCROLL_SUGGEST_PROVISION`: set `0` to skip MCP provisioning
+- `SCROLL_PLUGIN_DRY_RUN`: set `1` to disable spawning scroll (useful for tests)
+
+## Dev
+```bash
+bun install
+bun run lint
+bun test
+```

package/biome.json

@@ -0,0 +1,9 @@
+{
+	"$schema": "https://biomejs.dev/schemas/1.7.3/schema.json",
+	"formatter": {
+		"enabled": true
+	},
+	"linter": {
+		"enabled": true
+	}
+}

package/bun.lock

@@ -0,0 +1,31 @@
+{
+  "lockfileVersion": 1,
+  "configVersion": 1,
+  "workspaces": {
+    "": {
+      "name": "scroll-plugin",
+      "devDependencies": {
+        "@biomejs/biome": "^1.7.3",
+      },
+    },
+  },
+  "packages": {
+    "@biomejs/biome": ["@biomejs/biome@1.9.4", "", { "optionalDependencies": { "@biomejs/cli-darwin-arm64": "1.9.4", "@biomejs/cli-darwin-x64": "1.9.4", "@biomejs/cli-linux-arm64": "1.9.4", "@biomejs/cli-linux-arm64-musl": "1.9.4", "@biomejs/cli-linux-x64": "1.9.4", "@biomejs/cli-linux-x64-musl": "1.9.4", "@biomejs/cli-win32-arm64": "1.9.4", "@biomejs/cli-win32-x64": "1.9.4" }, "bin": { "biome": "bin/biome" } }, "sha512-1rkd7G70+o9KkTn5KLmDYXihGoTaIGO9PIIN2ZB7UJxFrWw04CZHPYiMRjYsaDvVV7hP1dYNRLxSANLaBFGpog=="],
+
+    "@biomejs/cli-darwin-arm64": ["@biomejs/cli-darwin-arm64@1.9.4", "", { "os": "darwin", "cpu": "arm64" }, "sha512-bFBsPWrNvkdKrNCYeAp+xo2HecOGPAy9WyNyB/jKnnedgzl4W4Hb9ZMzYNbf8dMCGmUdSavlYHiR01QaYR58cw=="],
+
+    "@biomejs/cli-darwin-x64": ["@biomejs/cli-darwin-x64@1.9.4", "", { "os": "darwin", "cpu": "x64" }, "sha512-ngYBh/+bEedqkSevPVhLP4QfVPCpb+4BBe2p7Xs32dBgs7rh9nY2AIYUL6BgLw1JVXV8GlpKmb/hNiuIxfPfZg=="],
+
+    "@biomejs/cli-linux-arm64": ["@biomejs/cli-linux-arm64@1.9.4", "", { "os": "linux", "cpu": "arm64" }, "sha512-fJIW0+LYujdjUgJJuwesP4EjIBl/N/TcOX3IvIHJQNsAqvV2CHIogsmA94BPG6jZATS4Hi+xv4SkBBQSt1N4/g=="],
+
+    "@biomejs/cli-linux-arm64-musl": ["@biomejs/cli-linux-arm64-musl@1.9.4", "", { "os": "linux", "cpu": "arm64" }, "sha512-v665Ct9WCRjGa8+kTr0CzApU0+XXtRgwmzIf1SeKSGAv+2scAlW6JR5PMFo6FzqqZ64Po79cKODKf3/AAmECqA=="],
+
+    "@biomejs/cli-linux-x64": ["@biomejs/cli-linux-x64@1.9.4", "", { "os": "linux", "cpu": "x64" }, "sha512-lRCJv/Vi3Vlwmbd6K+oQ0KhLHMAysN8lXoCI7XeHlxaajk06u7G+UsFSO01NAs5iYuWKmVZjmiOzJ0OJmGsMwg=="],
+
+    "@biomejs/cli-linux-x64-musl": ["@biomejs/cli-linux-x64-musl@1.9.4", "", { "os": "linux", "cpu": "x64" }, "sha512-gEhi/jSBhZ2m6wjV530Yy8+fNqG8PAinM3oV7CyO+6c3CEh16Eizm21uHVsyVBEB6RIM8JHIl6AGYCv6Q6Q9Tg=="],
+
+    "@biomejs/cli-win32-arm64": ["@biomejs/cli-win32-arm64@1.9.4", "", { "os": "win32", "cpu": "arm64" }, "sha512-tlbhLk+WXZmgwoIKwHIHEBZUwxml7bRJgk0X2sPyNR3S93cdRq6XulAZRQJ17FYGGzWne0fgrXBKpl7l4M87Hg=="],
+
+    "@biomejs/cli-win32-x64": ["@biomejs/cli-win32-x64@1.9.4", "", { "os": "win32", "cpu": "x64" }, "sha512-8Y5wMhVIPaWe6jw2H+KlEm4wP/f7EW3810ZLmDlrEEy5KvBsb9ECEfu/kMWD484ijfQ8+nIi0giMgu9g1UAuuA=="],
+  }
+}

package/index.js

@@ -0,0 +1,151 @@
+// Scroll OpenCode plugin: capture + suggest combined
+
+export const ScrollPlugin = async ({ client, directory }) => {
+	const CONFIG = {
+		scrollBin: process.env.SCROLL_BIN || "scroll",
+		suggestLimit: Number.parseInt(process.env.SCROLL_SUGGEST_LIMIT || "3", 10),
+		debounceMs: Number.parseInt(
+			process.env.SCROLL_SUGGEST_DEBOUNCE_MS || "800",
+			10,
+		),
+		provision: (process.env.SCROLL_SUGGEST_PROVISION || "1") === "1",
+		dryRun: (process.env.SCROLL_PLUGIN_DRY_RUN || "0") === "1",
+	};
+
+	let promptCaptured = false;
+	let lastInput = "";
+	let lastInjected = "";
+	let timer = null;
+	let runId = 0;
+
+	const log = async (level, message, extra = {}) => {
+		try {
+			if (client?.app?.log) {
+				await client.app.log({
+					service: "scroll-plugin",
+					level,
+					message,
+					extra,
+				});
+			} else {
+				console.log(`[scroll-plugin:${level}]`, message, extra);
+			}
+		} catch {
+			/* logging should never break the plugin */
+		}
+	};
+
+	const execScroll = async (args, env = {}) => {
+		if (CONFIG.dryRun) return "";
+
+		const scrollEnv = { ...process.env, ...env, SCROLL_SOURCE: "opencode" };
+
+		const proc = Bun.spawn([CONFIG.scrollBin, ...args], {
+			env: scrollEnv,
+			stdout: "pipe",
+			stderr: "pipe",
+		});
+
+		const stdout = await new Response(proc.stdout).text();
+		const stderr = await new Response(proc.stderr).text();
+
+		if (proc.exitCode !== 0) {
+			throw new Error(stderr || `scroll exited with code ${proc.exitCode}`);
+		}
+
+		return stdout.trim();
+	};
+
+	const scheduleSuggest = (text) => {
+		lastInput = text;
+		runId += 1;
+		const current = runId;
+
+		if (timer) clearTimeout(timer);
+
+		timer = setTimeout(() => {
+			void (async () => {
+				const prompt = lastInput.trim();
+				if (!prompt) return;
+				if (current !== runId) return;
+				if (prompt === lastInjected) return;
+
+				await log("debug", "running scroll suggest", {
+					cwd: directory,
+					prompt_len: prompt.length,
+				});
+
+				try {
+					const args = [
+						"suggest",
+						"skill",
+						prompt,
+						"--limit",
+						CONFIG.suggestLimit.toString(),
+					];
+					if (CONFIG.provision) args.push("--provision");
+
+					const suggestions = await execScroll(args);
+					if (!suggestions) return;
+					if (current !== runId) return;
+
+					lastInjected = prompt;
+					await client.tui.appendPrompt({
+						body: { text: `\n\n${suggestions}\n` },
+					});
+				} catch (e) {
+					await log("warn", "scroll suggest failed", { error: String(e) });
+				}
+			})();
+		}, CONFIG.debounceMs);
+	};
+
+	return {
+		"message.part.updated": async (input) => {
+			const role = input?.role;
+			const content = input?.content ?? "";
+
+			if (role === "user" && content?.trim() && !promptCaptured) {
+				promptCaptured = true;
+				try {
+					await execScroll(["capture", "hook", "prompt"], { PROMPT: content });
+				} catch (e) {
+					await log("warn", "capture prompt failed", { error: String(e) });
+					promptCaptured = false;
+				}
+			}
+		},
+
+		"message.updated": async (input) => {
+			const role = input?.role;
+			const content = input?.content ?? "";
+
+			if (role === "assistant" && content?.trim() && promptCaptured) {
+				try {
+					await execScroll(["capture", "hook", "response"], {
+						CLAUDE_RESPONSE: content,
+					});
+				} catch (e) {
+					await log("warn", "capture response failed", { error: String(e) });
+				}
+				promptCaptured = false;
+			}
+		},
+
+		"session.created": async (input) => {
+			await log("info", "session created", {
+				sessionId: input?.session?.id ?? "unknown",
+				isSubagent: input?.session?.parentId != null,
+				cwd: directory,
+			});
+		},
+
+		"tui.prompt.append": async (input) => {
+			const text = input?.text ?? "";
+			if (!text.trim()) return;
+			scheduleSuggest(text);
+		},
+	};
+};
+
+export default ScrollPlugin;

package/index.test.js

@@ -0,0 +1,32 @@
+import { describe, expect, it } from "bun:test";
+import ScrollPlugin from "./index.js";
+
+describe("ScrollPlugin", () => {
+	it("exposes handlers without executing scroll in dry-run", async () => {
+		process.env.SCROLL_PLUGIN_DRY_RUN = "1";
+
+		const appLogCalls = [];
+		const promptAppends = [];
+
+		const client = {
+			app: {
+				log: ({ level, message, extra }) =>
+					appLogCalls.push({ level, message, extra }),
+			},
+			tui: { appendPrompt: ({ body }) => promptAppends.push(body?.text ?? "") },
+		};
+
+		const plugin = await ScrollPlugin({ client, directory: "/tmp" });
+
+		expect(typeof plugin["message.part.updated"]).toBe("function");
+		expect(typeof plugin["message.updated"]).toBe("function");
+		expect(typeof plugin["tui.prompt.append"]).toBe("function");
+
+		await plugin["message.part.updated"]({ role: "user", content: "hello" });
+		await plugin["message.updated"]({ role: "assistant", content: "hi" });
+		await plugin["tui.prompt.append"]({ text: "prompt text" });
+
+		expect(promptAppends.length).toBeGreaterThanOrEqual(0);
+		expect(appLogCalls.length).toBeGreaterThanOrEqual(0);
+	});
+});

package/package.json

@@ -0,0 +1,15 @@
+{
+	"name": "scroll-plugin",
+	"version": "0.1.0",
+	"description": "OpenCode plugin for Scroll: capture + suggest in one module",
+	"main": "index.js",
+	"type": "module",
+	"license": "MIT",
+	"scripts": {
+		"lint": "bunx biome check .",
+		"test": "bun test --no-bail"
+	},
+	"devDependencies": {
+		"@biomejs/biome": "^1.7.3"
+	}
+}