Something went wrong. Try again.
trying to integrate chainlink into opencode
Something went wrong. Try again.
12 kB · 466 lines
TypeScript
at main
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467import { type Plugin, tool } from "@opencode-ai/plugin";
/** * Result type for chainlink command execution. */export interface ChainlinkResult { success: boolean; data?: string; error?: string;}
/** * Log levels for the plugin. */export type LogLevel = "debug" | "info" | "warn" | "error";
/** * Extension to language mapping for dynamic rule hints. * Maps file extensions to their corresponding rule file names. */const EXTENSION_TO_LANGUAGE: Record<string, string> = { // TypeScript/JavaScript ts: "typescript", tsx: "typescript", js: "javascript", jsx: "javascript", mjs: "javascript", cjs: "javascript",
// Go go: "go",
// Nix nix: "nix",
// C-family c: "c", h: "c", cpp: "cpp", cc: "cpp", cxx: "cpp", hpp: "cpp", cs: "csharp",
// JVM languages java: "java", kt: "kotlin", kts: "kotlin", scala: "scala", cls: "java",
// Functional languages hs: "haskell", lhs: "haskell", ml: "ocaml", mli: "ocaml", fs: "fsharp", fsi: "fsharp", clj: "clojure", rlib: "rust",
// Scripting languages py: "python", pyw: "python", rb: "ruby", erb: "ruby", php: "php", pl: "perl", pm: "perl", lua: "lua",
// Shell sh: "shell", bash: "shell", zsh: "shell", ps1: "powershell", bat: "batch", cmd: "batch",
// Systems programming rs: "rust", swift: "swift", mm: "objectivec", d: "d", v: "v", zig: "zig", vala: "vala",
// Other compiled ex: "elixir", exs: "elixir", erl: "erlang", hrl: "erlang", jl: "julia", cr: "crystal", nim: "nim", rkt: "racket",
// Web markup/styles html: "html", htm: "html", css: "css", scss: "css", sass: "css", less: "css",
// Data/Config json: "json", yaml: "yaml", yml: "yaml", xml: "xml", toml: "toml",
// Documentation md: "markdown", markdown: "markdown", tex: "latex", latex: "latex",
// Database sql: "sql", ddl: "sql",
// Build systems make: "makefile", cmake: "cmake", dockerfile: "docker",
// Other csv: "csv", r: "r", m: "matlab", asm: "assembly", s: "assembly", f: "fortran", f90: "fortran",};
/** * Extract file extension and map to language name. */function getLanguageFromFilePath(filePath: string): string | null { const match = filePath.match(/\.([a-zA-Z0-9]+)(?:\?.*)?$/); if (!match) return null;
const ext = match[1]!.toLowerCase(); return EXTENSION_TO_LANGUAGE[ext] ?? null;}
/** * Registry to track which rules have been read in each session. */const sessionRulesRead = new Map<string, Set<string>>();
/** * Helper class for executing chainlink commands and interacting with OpenCode client. */class ChainlinkService { constructor( private readonly $: Awaited<Parameters<Plugin>[0]["$"]>, private readonly client: Parameters<Plugin>[0]["client"], ) { this.$.throws(true); }
/** * Execute a chainlink command with proper error handling. */ async run( args: string[], description: string = "execute chainlink command", ): Promise<ChainlinkResult> { try { const fullCmd = this.$`chainlink ${args}`;
const text = await Promise.race([ fullCmd.text(), new Promise<never>((_, reject) => setTimeout( () => reject(new Error("Command timed out after 2 seconds")), 2000, ), ), ]);
return { success: true, data: text }; } catch (error) { return { success: false, error: `Failed to ${description}: ${error instanceof Error ? error.message : String(error)}`, }; } }
/** * Log a message using the OpenCode logging API. */ async log(level: LogLevel, message: string): Promise<void> { await this.client.app .log({ body: { service: "chainlink-plugin", level, message, }, }) .catch(() => {}); }
/** * Send a prompt to the current session. */ async prompt(sessionID: string, text: string): Promise<void> { await this.client.session .prompt({ path: { id: sessionID }, body: { noReply: true, parts: [{ type: "text", text }], }, }) .catch(async (error) => { await this.log( "warn", `Failed to send prompt to session ${sessionID}: ${error instanceof Error ? error.message : String(error)}`, ); }); }}
export const ChainlinkPlugin: Plugin = async ({ $, client, directory }) => { const service = new ChainlinkService($, client);
return { tool: { /** * Execute any chainlink command. */ chainlink: tool({ description: "Execute any chainlink command. Examples: 'show 42', 'create \"title\" -p high', 'comment 42 \"done\"', 'list --status open'. Note: 'delete' is interactive; use '-f' or '--force' to skip confirmation.", args: { command: tool.schema .array(tool.schema.string()) .describe("The chainlink command and arguments (e.g. 'show 42')"), }, async execute(args) { const result = await service.run(args.command); return result.success ? result.data || "" : `Error: ${result.error}`; }, }),
/** * Suggest the next issue to work on. */ chainlink_next: tool({ description: "Get smart recommendation for what to work on next based on priority, blocking relationships, and session history", args: {}, async execute() { const result = await service.run(["next"], "get next suggestion"); return result.success ? result.data || "No issues ready. Create one with `chainlink` tool!" : "Unable to get suggestions. Try creating some issues first!"; }, }),
/** * Read coding rules from .chainlink/rules directory. */ chainlink_rules: tool({ description: "Read coding rules from .chainlink/rules directory", args: { rule: tool.schema .string() .optional() .describe( "Specific rule file to read (e.g., 'typescript', 'go', 'javascript')", ), }, async execute(args, toolCtx) { const ruleFile = args.rule || "global"; const sessionID = toolCtx?.sessionID;
if (sessionID) { if (!sessionRulesRead.has(sessionID)) { sessionRulesRead.set(sessionID, new Set()); } sessionRulesRead.get(sessionID)?.add(ruleFile); }
const paths = [ `${directory}/.chainlink/rules/${ruleFile}.md`, `${directory}/.chainlink/rules/${ruleFile}`, `${directory}/.chainlink/rules/global.md`, `${directory}/.chainlink/rules/global`, ];
const rulesDir = process.env.CHAINLINK_RULES_DIR; if (rulesDir) { paths.push( `${rulesDir}/${ruleFile}.md`, `${rulesDir}/${ruleFile}`, `${rulesDir}/global.md`, `${rulesDir}/global`, ); }
for (const rulePath of paths) { try { const content = await $`cat "${rulePath}"`.text(); if (content.trim()) return content.trim(); } catch {} }
return `No rule file found for '${ruleFile}'. Available rules: global, go, javascript, nix, typescript`; }, }),
/** * Manage chainlink sessions. */ chainlink_session: tool({ description: "Manage chainlink sessions (start, end, work, status)", args: { action: tool.schema .enum(["start", "end", "work", "status"]) .describe("Session action to perform"), id: tool.schema .string() .optional() .describe("Issue ID for 'work' action"), notes: tool.schema .string() .optional() .describe("Handoff notes for 'end' action"), }, async execute(args) { const { action, id, notes } = args;
switch (action) { case "start": { const result = await service.run( ["session", "start"], "start session", ); return result.data || result.error || "Failed to start session"; } case "end": { if (!notes) return "Error: Notes are required for ending a session"; const result = await service.run( ["session", "end", "--notes", notes], "end session", ); return result.data || result.error || "Failed to end session"; } case "work": { if (!id) return "Error: Issue ID is required for 'work' action"; const cleanId = id.replace("#", ""); const result = await service.run( ["session", "work", cleanId], "set session work issue", ); return result.data || result.error || "Failed to set work issue"; } case "status": { const result = await service.run( ["session", "status"], "get session status", ); return ( result.data || result.error || "Failed to get session status" ); } default: return `Error: Unknown session action '${action}'`; } }, }), },
// === Lifecycle Hooks ===
"tool.execute.before": async (input) => { const { tool: toolName, sessionID, args, } = input as { tool: string; sessionID: string; callID: string; args?: Record<string, unknown>; };
if (!sessionID) return;
// Before any modification or read, ensure rules are being respected const rulesRead = sessionRulesRead.get(sessionID); const hasReadGlobal = rulesRead?.has("global");
// Always warn on modification if global rules haven't been read if ((toolName === "write" || toolName === "edit") && !hasReadGlobal) { await service.prompt( sessionID, "**ATTENTION:** You are attempting to modify code without having read the project's coding rules. Please run `chainlink_rules({ rule: 'global' })` (and any language-specific rules) BEFORE making changes to ensure quality and consistency.", ); return; }
// On read, suggest language rules if global is already read but language rules aren't if (toolName === "read") { const filePath = args?.filePath as string | undefined; if (!filePath) return;
const languageRule = getLanguageFromFilePath(filePath); if (!languageRule) return; if (rulesRead?.has(languageRule)) return;
const languageDisplay = languageRule.charAt(0).toUpperCase() + languageRule.slice(1); const ext = filePath.split(".").pop()?.toLowerCase();
await service.prompt( sessionID, `**Hint:** You're reading a ${ext} file. ${!hasReadGlobal ? "Please read the `global` rules first, and then consider" : "Consider"} reading the ${languageDisplay} rules with \`chainlink_rules({ rule: '${languageRule}' }})\`.`, ); } },
"session.created": async ({ sessionID }: { sessionID: string }) => { sessionRulesRead.delete(sessionID);
try { const readyResult = await service.run(["ready"], "get ready issues"); const readyData = readyResult.data || ""; const lines = readyData.split("\n").filter(Boolean); const topIssues = lines.slice(0, 3).join("\n");
const contextText = `## Chainlink Issues
**Ready to work:** ${lines.length} issue${lines.length !== 1 ? "s" : ""}${topIssues ? `\n**Top priorities:**\n${topIssues}` : ""}
${lines.length > 3 ? "> Use chainlink({ command: 'ready' }) for full list" : ""}
---
**CRITICAL:** Before writing or editing any code, you MUST read the project coding rules using the \`chainlink_rules\` tool. This ensures consistency and quality.
Recommended rules to check: \`global\`, \'your-language\'.
When reading code files, the system will automatically detect the language and remind you to read language-specific rules (e.g., reading \`.ts\` files → read \`typescript\` rules).`;
await service.prompt(sessionID, contextText); } catch (error) { await service.log( "error", `Failed to inject session context: ${error instanceof Error ? error.message : "Unknown error"}`, ); } }, };};