opencode-readseek 0.11.0 → 0.11.2

package/README.md

@@ -58,6 +58,11 @@ Use `at` selectors (`line:N[:COLUMN]`, `hash:H[:COLUMN]`, `symbol:NAME`,
 `depth: 1`. Use separate structure, metadata, and syntax tools rather than
 combining facets in a content request.
 
+The four `show` tools return readable summaries and grouped text: anchored source
+lines, document sections, structure trees, metadata fields, and asset paths.
+Notices identify omitted ranges and how to continue. The unchanged native result
+is retained separately in `metadata.readseek`; image attachments are unchanged.
+
 `readseek_find_nodes` accepts `pattern`, `context` with `selector`, or `rule`.
 `readseek_find_references` requires exactly one of `name` or `at`; binding
 references and renames use line or hash cursors. KDL selection/check rules

package/dist/index.js

@@ -1028,6 +1028,221 @@ function serializeEditPlan(edits) {
     throw new Error(validation.error);
   return format(new Document([node("plan", {}, validation.edits.map(editNode))]));
 }
+// ../readseek-api/src/show-presentation.ts
+function isShowTool(name) {
+  return name === "show_content" || name === "show_structure" || name === "show_metadata" || name === "show_assets";
+}
+function record(value) {
+  return value !== null && typeof value === "object" && !Array.isArray(value) ? value : {};
+}
+function records(value) {
+  return Array.isArray(value) ? value.map(record) : [];
+}
+function text(value) {
+  return typeof value === "string" ? value : "";
+}
+function count(value) {
+  return typeof value === "number" && Number.isSafeInteger(value) && value >= 0 ? value : undefined;
+}
+function safe(value) {
+  return value.replace(/[\x00-\x09\x0b-\x1f\x7f-\x9f]/g, (char) => {
+    if (char === "\t")
+      return "\\t";
+    if (char === "\r")
+      return "\\r";
+    return `\\x${char.charCodeAt(0).toString(16).padStart(2, "0")}`;
+  });
+}
+function inline(value) {
+  return safe(text(value)).replaceAll(`
+`, "\\n");
+}
+function plural(n, unit) {
+  return `${n} ${unit}${n === 1 ? "" : "s"}`;
+}
+function fields(value, omit = []) {
+  return Object.entries(value).flatMap(([key, item]) => {
+    if (omit.includes(key) || item === undefined || item === null || typeof item === "object")
+      return [];
+    const label = key.replaceAll("_", " ");
+    return [`${label[0]?.toUpperCase() ?? ""}${label.slice(1)}: ${safe(String(item))}`];
+  }).join(`
+`);
+}
+function location(value) {
+  const start = text(value.start_anchor) || (count(value.start_line) !== undefined ? `${value.start_line}${text(value.start_hash) ? `:${value.start_hash}` : ""}` : "");
+  const end = text(value.end_anchor) || (count(value.end_line) !== undefined ? `${value.end_line}${text(value.end_hash) ? `:${value.end_hash}` : ""}` : "");
+  return start ? `  ${inline(start)}${end && end !== start ? ` - ${inline(end)}` : ""}` : "";
+}
+function sourceStructure(structure) {
+  const sections = [];
+  if (structure.root) {
+    const lines = [];
+    const stack = [{ node: record(structure.root), depth: 0 }];
+    while (stack.length > 0) {
+      const { node, depth } = stack.pop();
+      lines.push(`${"  ".repeat(Math.min(depth, 12))}${inline(node.kind) || "node"}${text(node.name) ? ` ${inline(node.name)}` : ""}${location(node)}`);
+      const children = records(node.children);
+      for (let i = children.length - 1;i >= 0; i--)
+        stack.push({ node: children[i], depth: depth + 1 });
+    }
+    sections.push(`Tree
+${lines.join(`
+`)}`);
+  }
+  const symbols = records(structure.symbols);
+  if (symbols.length > 0) {
+    sections.push(`Symbols
+${symbols.map((symbol) => `${inline(symbol.kind) || "symbol"} ${inline(symbol.qualified_name || symbol.name)}${location(symbol)}`).join(`
+`)}`);
+  }
+  return sections.join(`
+
+`) || "No structure found in this selection.";
+}
+function documentNodes(nodes, content) {
+  const depths = new Map;
+  return nodes.map((node) => {
+    const depth = Math.min((depths.get(text(node.parent_id)) ?? -1) + 1, 12);
+    depths.set(text(node.id), depth);
+    const indent = "  ".repeat(depth);
+    const label = inline(node.title) || inline(node.kind) || "node";
+    const page = count(node.page);
+    const selector = text(node.id) ? `node:${inline(node.id)}` : "";
+    const position = [selector, page !== undefined ? `page:${page}` : ""].filter(Boolean).join(" · ");
+    const heading = `${indent}${label}${position ? `  [${position}]` : ""}`;
+    const body = text(node.text);
+    return content && body ? `${heading}
+${safe(body).split(`
+`).map((line) => indent + line).join(`
+`)}` : heading;
+  }).join(content ? `
+
+` : `
+`);
+}
+function assetList(assets) {
+  return assets.map((asset) => {
+    const id = text(asset.id);
+    const page = count(asset.page);
+    const heading = [id ? `asset:${inline(id)}` : inline(asset.kind) || "image", inline(asset.mime), page !== undefined ? `page:${page}` : ""].filter(Boolean).join(" · ");
+    const details = fields(asset, ["id", "kind", "mime", "page", "bbox", "content_identity"]);
+    return `${heading}${details ? `
+${details.split(`
+`).map((line) => `  ${line}`).join(`
+`)}` : ""}`;
+  }).join(`
+
+`);
+}
+function presentShowResult(tool, value, options = {}) {
+  const output = record(value);
+  const metadata = record(output.metadata);
+  const content = record(output.content);
+  const cursor = record(output.cursor);
+  const structure = record(output.structure);
+  const document = typeof output.format === "string" && (Array.isArray(output.nodes) || typeof output.source === "string");
+  const path = inline(options.path || output.source || output.file || content.file || structure.file || metadata.file || cursor.file) || "(unknown path)";
+  const summary = [];
+  const result = { summary: "", body: "", notices: [], metadata: {} };
+  if (tool === "show_metadata") {
+    const data = Object.keys(metadata).length > 0 ? metadata : output;
+    if (text(data.format || data.language || data.type))
+      summary.push(inline(data.format || data.language || data.type));
+    if (count(data.pages) !== undefined) {
+      result.metadata.pages = data.pages;
+      summary.push(plural(result.metadata.pages, "page"));
+    }
+    result.body = fields(data) || "No metadata available.";
+  } else if (tool === "show_assets") {
+    const assets = records(output.assets);
+    result.metadata.assets = assets.length;
+    summary.push(plural(assets.length, "asset"));
+    result.body = assetList(assets) || "No assets in this selection.";
+  } else if (document) {
+    const nodes = records(output.nodes);
+    const assets = records(output.assets);
+    result.metadata.nodes = nodes.length;
+    if (count(output.pages) !== undefined)
+      result.metadata.pages = output.pages;
+    summary.push(plural(nodes.length, "node"));
+    if (result.metadata.pages !== undefined)
+      summary.push(plural(result.metadata.pages, "page"));
+    const sections = [text(output.title) ? safe(text(output.title)) : "", documentNodes(nodes, tool === "show_content")];
+    if (assets.length > 0) {
+      result.metadata.assets = assets.length;
+      sections.push(`Assets
+${assetList(assets)}`);
+    }
+    result.body = sections.filter(Boolean).join(`
+
+`) || "No content in this selection.";
+  } else if (tool === "show_structure") {
+    const symbols = records(structure.symbols);
+    result.metadata.symbols = symbols.length;
+    summary.push(plural(symbols.length, "symbol"));
+    result.body = sourceStructure(structure);
+  } else if (content.kind === "image" || count(content.width) !== undefined && count(content.height) !== undefined || count(metadata.width) !== undefined && count(metadata.height) !== undefined || text(content.mime).startsWith("image/") || text(metadata.mime).startsWith("image/") || text(metadata.type).startsWith("image/")) {
+    const description = Object.keys(content).length > 0 ? content : Object.keys(metadata).length > 0 ? metadata : output;
+    if (count(description.width) !== undefined && count(description.height) !== undefined) {
+      summary.push(`${description.width} × ${description.height}`);
+    } else if (count(metadata.width) !== undefined && count(metadata.height) !== undefined) {
+      summary.push(`${metadata.width} × ${metadata.height}`);
+    }
+    const mime = text(description.mime || metadata.mime || metadata.type);
+    if (mime)
+      summary.push(inline(mime));
+    result.body = fields(description, ["hashlines"]) || fields(metadata) || "No content in this selection.";
+  } else if (Array.isArray(content.hashlines) || Array.isArray(cursor.hashlines)) {
+    const lines = records(content.hashlines ?? cursor.hashlines);
+    const start = count(content.start_line) ?? count(lines[0]?.line);
+    const end = count(content.end_line) ?? count(lines.at(-1)?.line);
+    const total = count(content.line_count) ?? count(cursor.line_count);
+    if (start !== undefined && end !== undefined && start <= end) {
+      result.metadata.start_line = start;
+      result.metadata.end_line = end;
+      summary.push(`lines ${start}-${end}${total !== undefined ? ` of ${total}` : ""}`);
+    } else
+      summary.push(plural(lines.length, "line"));
+    const lang = text(metadata.language || content.language);
+    if (lang)
+      summary.push(inline(lang));
+    const rows = lines.map((line) => `${line.line}${options.noAnchors ? "" : `:${text(line.hash)}`} | ${safe(text(line.text)).replaceAll("\\n", "\\\\n")}`);
+    const identifier = record(cursor.identifier);
+    if (count(cursor.line) !== undefined)
+      result.metadata.line = cursor.line;
+    if (count(cursor.column) !== undefined)
+      result.metadata.column = cursor.column;
+    if (Object.keys(cursor).length > 0) {
+      const symbol = record(cursor.symbol);
+      const description = [text(identifier.text), text(symbol.qualified_name || symbol.name), text(symbol.kind)].filter(Boolean);
+      rows.unshift(`Cursor: ${cursor.line ?? "?"}:${cursor.column ?? "?"}${description.length > 0 ? ` · ${[...new Set(description)].map(inline).join(" · ")}` : ""}`, "");
+    }
+    result.body = rows.join(`
+`) || "Empty source selection.";
+    if (start !== undefined && start > 1)
+      result.notices.push(`Earlier lines omitted. Read preceding content with at: line:1 and limit: ${start - 1}.`);
+    if (end !== undefined && total !== undefined && end < total) {
+      result.notices.push(`More lines available. Continue with at: line:${end + 1}.`);
+    } else if (content.truncated === true && (end === undefined || total === undefined)) {
+      result.notices.push(`Content is truncated.${end !== undefined ? ` Continue with at: line:${end + 1}.` : " Select a smaller range with at and limit."}`);
+    }
+  } else {
+    const description = Object.keys(content).length > 0 ? content : output;
+    result.body = fields(description) || "No content in this selection.";
+  }
+  if (tool === "show_structure")
+    result.notices.push("Structure is limited to the requested depth, kind, and outline. Use a deeper depth or focus with at to inspect further.");
+  if (text(output.warning))
+    result.notices.push(safe(text(output.warning)));
+  result.summary = summary.join(" · ") || "complete";
+  return result;
+}
+function formatShowResult(presentation) {
+  return [presentation.summary, presentation.body, ...presentation.notices.map((notice) => `Note: ${notice}`)].filter(Boolean).join(`
+
+`);
+}
 // ../readseek-api/src/platform.ts
 import { accessSync, constants as fsConstants, existsSync, statSync } from "node:fs";
 import { createRequire } from "node:module";
@@ -1581,7 +1796,7 @@ import path4 from "node:path";
 function render(value) {
   return JSON.stringify(value, null, 2);
 }
-function record(value) {
+function record2(value) {
   return value && typeof value === "object" ? value : {};
 }
 function items(value) {
@@ -1606,19 +1821,19 @@ function collectAnchoredFiles(value, files) {
     return;
   const output = value;
   const hashlines = output.hashlines;
-  if (typeof output.file === "string" && Array.isArray(hashlines) && hashlines.some((line) => typeof record(line).line === "number" && typeof record(line).hash === "string"))
+  if (typeof output.file === "string" && Array.isArray(hashlines) && hashlines.some((line) => typeof record2(line).line === "number" && typeof record2(line).hash === "string"))
     files.add(output.file);
   for (const item of Object.values(output))
     collectAnchoredFiles(item, files);
 }
 function renameFiles(value, directory = process.cwd()) {
-  const output = record(value);
+  const output = record2(value);
   const files = [];
   if (typeof output.file === "string" && items(output.edits).length > 0) {
     files.push(path4.resolve(directory, output.file));
   }
   for (const other of items(output.others)) {
-    const item = record(other);
+    const item = record2(other);
     if (typeof item.file === "string" && items(item.edits).length > 0) {
       files.push(path4.resolve(directory, item.file));
     }
@@ -1675,7 +1890,7 @@ function contentArgs(filePath, options = {}) {
   return buildShowContentArgs({ path: filePath, ...options, at: options.at ?? (options.end === undefined ? undefined : "line:1") });
 }
 function requireContent(envelope) {
-  const value = record(envelope).content;
+  const value = record2(envelope).content;
   if (value === undefined || value === null || typeof value !== "object") {
     throw new Error("show content returned no source content");
   }
@@ -2200,52 +2415,27 @@ function initialTitle(kind, args) {
   }
 }
 function resultPresentation(kind, args, value) {
-  const output = record(value);
+  const output = record2(value);
+  if (isShowTool(kind)) {
+    const presentation = presentShowResult(kind, value, args);
+    return { title: presentation.summary, metadata: presentation.metadata };
+  }
   switch (kind) {
-    case "show_assets":
-      return { title: `Assets ${args.path}`, metadata: {} };
-    case "show_structure": {
-      const symbols = items(record(output.structure).symbols).length;
-      return { title: `Structure ${args.path} (${symbols} symbols)`, metadata: { symbols } };
-    }
     case "check_syntax": {
-      const diagnostics = record(output.diagnostics ?? output);
+      const diagnostics = record2(output.diagnostics ?? output);
       const errors = typeof diagnostics.error_count === "number" ? diagnostics.error_count : 0;
       const missing = typeof diagnostics.missing_count === "number" ? diagnostics.missing_count : 0;
       return { title: `Syntax ${args.path} (${errors} errors, ${missing} missing)`, metadata: { error_count: errors, missing_count: missing } };
     }
-    case "show_content": {
-      const identity = record(output.cursor);
-      const content = record(output.content);
-      const metadata = {};
-      const summary = [];
-      if (output.cursor !== undefined) {
-        if (typeof identity.line === "number")
-          metadata.line = identity.line;
-        if (typeof identity.column === "number")
-          metadata.column = identity.column;
-        const identifier = record(identity.identifier).text;
-        if (typeof identifier === "string")
-          summary.push(identifier);
-      }
-      if (typeof content.start_line === "number")
-        metadata.start_line = content.start_line;
-      if (typeof content.end_line === "number")
-        metadata.end_line = content.end_line;
-      return {
-        title: summary.length > 0 ? `Read ${args.path} (${summary.join(", ")})` : `Read ${args.path}`,
-        metadata
-      };
-    }
     case "find_nodes": {
       const results = items(output.results);
-      const matches = results.reduce((total, result) => total + items(record(result).matches).length, 0);
+      const matches = results.reduce((total, result) => total + items(record2(result).matches).length, 0);
       return { title: `Found ${matches} matches`, metadata: { results: results.length, matches } };
     }
     case "find_text": {
       const results = items(output.results);
       const matches = results.reduce((total, result) => {
-        const entry = record(result);
+        const entry = record2(result);
         return total + (typeof entry.count === "number" ? entry.count : items(entry.matches).length);
       }, 0);
       return { title: `Found ${matches} matches`, metadata: { results: results.length, matches } };
@@ -2261,7 +2451,7 @@ function resultPresentation(kind, args, value) {
     case "rename_symbol": {
       const oldName = output.old_name;
       const newName = output.new_name;
-      const otherOutputs = items(output.others).map(record);
+      const otherOutputs = items(output.others).map(record2);
       const edits = otherOutputs.reduce((total, item) => total + items(item.edits).length, items(output.edits).length);
       const conflicts = otherOutputs.reduce((total, item) => total + items(item.conflicts).length, items(output.conflicts).length);
       const others = otherOutputs.length;
@@ -2302,11 +2492,12 @@ function readseekTool(description, args, kind, execute, imagePolicy) {
         if (imagePolicy !== "off")
           attachments.push({ type: "file", mime, url: pathToFileURL(path).href });
       }
+      const displayResult = imagePolicy === "off" && imagePaths.size > 0 ? { ...record2(result), warning: "Image attachments are disabled; use the returned paths to view the images." } : result;
       return {
         ...attachments.length > 0 ? { attachments } : {},
         title: presentation.title,
-        output: render(imagePolicy === "off" && imagePaths.size > 0 ? { ...record(result), warning: "Image attachments are disabled; use the returned paths to view the images." } : result),
-        metadata: presentation.metadata
+        output: isShowTool(kind) ? formatShowResult(presentShowResult(kind, displayResult, args)) : render(displayResult),
+        metadata: { ...presentation.metadata, ...isShowTool(kind) ? { readseek: result } : {} }
       };
     }
   });
@@ -2400,16 +2591,16 @@ function createReadSeekTools(imagePolicy) {
         }
         const linesByNumber = new Map;
         for (const [start, end] of mergedRanges) {
-          const output = record(await runContent(context, readRangeArgs(filePath, start, end)));
+          const output = record2(await runContent(context, readRangeArgs(filePath, start, end)));
           for (const hashline of items(output.hashlines)) {
-            const line = record(hashline).line;
+            const line = record2(hashline).line;
             if (typeof line === "number" && !linesByNumber.has(line))
               linesByNumber.set(line, hashline);
           }
         }
         const hashlines = [...linesByNumber.values()];
         const matches = hashlines.filter((hashline) => {
-          const line = record(hashline).line;
+          const line = record2(hashline).line;
           return typeof line === "number" && matchLines.has(line);
         });
         results.push({ file: filePath, matches, hashlines });
@@ -2494,7 +2685,7 @@ function createReadSeekTools(imagePolicy) {
       await authorizeRead(context, filePath);
       if (input.workspace) {
         const envelope = await runReadSeek(context, contentArgs(filePath, { at: input.at }));
-        const name = identifiedName(record(envelope).cursor);
+        const name = identifiedName(record2(envelope).cursor);
         if (!name)
           throw new Error("readseek could not identify a binding at the rename cursor");
         await authorizeSearch(context, context.directory, name);
@@ -2508,13 +2699,13 @@ function createReadSeekTools(imagePolicy) {
         gitScope: input.gitScope
       });
       const plan = await runReadSeek(context, args);
-      if (input.planHash !== undefined && record(plan).plan_hash !== input.planHash) {
+      if (input.planHash !== undefined && record2(plan).plan_hash !== input.planHash) {
         throw new Error("readseek rename plan does not match planHash");
       }
       if (input.apply === false)
         return plan;
       const files = renameFiles(plan, context.directory);
-      const planHash = record(plan).plan_hash;
+      const planHash = record2(plan).plan_hash;
       if (typeof planHash !== "string" || planHash.length === 0) {
         throw new Error("readseek rename plan did not include a plan hash");
       }
@@ -2588,7 +2779,7 @@ function createReadSeekTools(imagePolicy) {
           gitScope: input.gitScope,
           requestFromStdin: true
         });
-        const plan = record(await runReadSeek(context, baseArgs, { stdin: request }));
+        const plan = record2(await runReadSeek(context, baseArgs, { stdin: request }));
         if (typeof plan.before_content !== "string" || typeof plan.content !== "string" || typeof plan.plan_hash !== "string") {
           throw new Error("readseek edit plan is missing before_content, content, or plan_hash");
         }
@@ -2606,7 +2797,7 @@ function createReadSeekTools(imagePolicy) {
         }
         await authorizeEdit(context, [filePath], simpleDiff(filePath, before, after), false);
         context.abort.throwIfAborted();
-        const applied = record(await runReadSeek(context, buildEditTextArgs({
+        const applied = record2(await runReadSeek(context, buildEditTextArgs({
           path: filePath,
           language: input.language,
           gitScope: input.gitScope,
@@ -2776,7 +2967,7 @@ var ReadSeekPlugin = async (_input, options) => {
         const result = JSON.parse(output.output);
         if (input.tool === "readseek_rename_symbol") {
           anchors.planRename(input.sessionID, result);
-          if (record(result).applied === true) {
+          if (record2(result).applied === true) {
             for (const filePath of renameFiles(result))
               anchors.forget(filePath);
           }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "opencode-readseek",
-  "version": "0.11.0",
+  "version": "0.11.2",
   "description": "OpenCode plugin for anchored file operations and structural code navigation",
   "type": "module",
   "main": "./dist/index.js",
@@ -33,8 +33,8 @@
     "node": ">=20.0.0"
   },
   "dependencies": {
-    "@jarkkojs/readseek": "^0.11.0",
-    "@jarkkojs/readseek-api": "^0.11.0",
+    "@jarkkojs/readseek": "^0.11.2",
+    "@jarkkojs/readseek-api": "^0.11.2",
     "@opencode-ai/plugin": "^1.18.18"
   },
   "devDependencies": {