opencode-readseek 0.9.15 → 0.9.16

package/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/README.md

@@ -13,7 +13,7 @@ Add the plugin to `opencode.json`:
 }
 ```
 
-The plugin uses the native binary supplied by `@jarkkojs/readseek`. Set
+The plugin uses the native binary supplied by `@jarkkojs/readseek-api`. Set
 `READSEEK_BINARY` to an absolute executable path to override it.
 
 ## Tools
@@ -43,4 +43,5 @@ bun run typecheck
 
 ## Licensing
 
-[Apache 2.0](../../LICENSE-APACHE-2.0).
+`opencode-readseek` is licensed under the Apache 2.0 license. See [LICENSE](LICENSE)
+for more information.

package/dist/index.js

@@ -63,6 +63,7 @@ var PARAM_DESCRIPTIONS = {
   at: "Location: line:N[:COLUMN], hash:HASH[:COLUMN], or symbol:NAME",
   end: "Last line to include",
   limit: "Maximum number of lines to include",
+  digestDepth: "Maximum structural depth for map output; defaults to 1 in agent tools",
   offset: "One-based starting line",
   readLimit: "Maximum lines to return",
   symbolRead: "Symbol name to read",
@@ -112,7 +113,7 @@ var PARAM_DESCRIPTIONS = {
   scopeContext: "Context lines within each symbol"
 };
 var TOOL_DESCRIPTIONS = {
-  digest: "Digest source content and images into the native CLI envelope. Returns metadata plus requested facets unchanged from `readseek digest`. Use it before edits to obtain fresh `LINE:HASH` anchors; use for structural maps, diagnostics, and cursor identity.",
+  digest: "Digest source content and images into the native CLI envelope. Returns metadata plus requested facets unchanged from `readseek digest`. Use it before edits to obtain fresh `LINE:HASH` anchors; use shallow maps for structural overviews, diagnostics for syntax checks, and identity for cursor context.",
   edit: 'Edit existing text files with fresh `LINE:HASH` anchors. Read or search first when no fresh anchors are available. Each `edits[]` item must use exactly one nested object: `{"set_line":{"anchor":"LINE:HASH","new_text":"..."}}`, `{"replace_lines":{"start_anchor":"LINE:HASH","end_anchor":"LINE:HASH","new_text":"..."}}`, `{"insert_after":{"anchor":"LINE:HASH","new_text":"..."}}`, `{"replace_symbol":{"symbol":"name","new_body":"..."}}`, or `{"replace":{"old_text":"...","new_text":"..."}}`.',
   write: "Create or replace a complete text file and return `LINE:HASH` anchors. Use `edit` for small changes to an existing file.",
   grep: "Search text or regex in files and return edit-ready `LINE:HASH` anchors. Use for identifiers, strings, configuration, errors, comments, and documentation.",
@@ -216,6 +217,7 @@ var TOOL_CONTRACTS = [
         at: { type: "string", description: PARAM_DESCRIPTIONS.at },
         end: { type: "integer", minimum: 1, description: PARAM_DESCRIPTIONS.end },
         limit: { type: "integer", minimum: 1, description: PARAM_DESCRIPTIONS.limit },
+        depth: { type: "integer", minimum: 0, description: PARAM_DESCRIPTIONS.digestDepth },
         language: { type: "string", description: PARAM_DESCRIPTIONS.languageOverride },
         visionMode: {
           type: "string",
@@ -456,7 +458,7 @@ function renderToolRoutingPolicy(options = {}) {
   if (options.style === "server") {
     return [
       "Structural code navigation, document viewing, and hash-verified edits with readseek.",
-      "For structural questions, prefer these tools to text Grep/Bash: definitions, references, AST search, multi-facet digest (content/map/diagnostics/identity), and document views.",
+      "For structural questions, prefer these tools to text Grep/Bash: targeted definitions, references, and AST search; shallow digest maps; diagnostics and identity; and document views.",
       `Use ${edit} for LINE:HASH-anchored mutations (preview with apply=false; apply defaults to true and re-checks plan_hash).`,
       "Paths resolve against CLAUDE_PROJECT_DIR. Native Read/Grep/Edit hooks provide passive context;",
       "call MCP tools for active navigation, document questions, or anchored edits."
@@ -467,7 +469,7 @@ function renderToolRoutingPolicy(options = {}) {
   if (options.preferOverBuiltIns) {
     bullets.push("- Prefer ReadSeek tools over built-ins when they can do the job.");
   }
-  bullets.push(`- Read with ${digest} first; ${edit} needs fresh LINE:HASH anchors.`, `- Use ${grep} for text/regex, ${search} for AST patterns, and ${digest}/${def}/${refs} for symbol navigation.`, `- Use ${edit} for existing files, ${write} for whole-file creation or replacement, and ${rename} for symbol renames.`, `- Use ${view} for document structure; run ${digest} with select diagnostics after source edits for a quick syntax check.`);
+  bullets.push(`- Read with ${digest} first; ${edit} needs fresh LINE:HASH anchors.`, `- Use ${grep} for text/regex, ${search} for AST patterns, ${def}/${refs} for targeted symbols, and shallow ${digest} maps only for file overviews.`, `- Use ${edit} for existing files, ${write} for whole-file creation or replacement, and ${rename} for symbol renames.`, `- Use ${view} for document structure; run ${digest} with select diagnostics after source edits for a quick syntax check.`);
   if (options.demoteBuiltIns && options.demoteBuiltIns.length > 0) {
     bullets.push(`- Do not use built-in ${options.demoteBuiltIns.join(", ")} when a ReadSeek tool can do the job.`);
   }
@@ -600,6 +602,7 @@ function validateExactlyOneEditVariant(edits) {
 var MIN_SAFE_INTEGER = BigInt(Number.MIN_SAFE_INTEGER);
 var MAX_SAFE_INTEGER = BigInt(Number.MAX_SAFE_INTEGER);
 // ../readseek-api/src/argv.ts
+var DEFAULT_DIGEST_MAP_DEPTH = 1;
 function buildLineLocation(line, column) {
   return column === undefined ? `line:${line}` : `line:${line}:${column}`;
 }
@@ -642,6 +645,10 @@ function selectArg(select) {
     return;
   return Array.isArray(select) ? select.join(",") : select;
 }
+function selectsDigestMap(select) {
+  const value = selectArg(select);
+  return value?.split(",").some((facet) => facet.trim() === "map") ?? false;
+}
 function buildDigestArgs(input) {
   const vision = validateVisionLevelVsMode({
     visionMode: input.visionMode,
@@ -649,6 +656,14 @@ function buildDigestArgs(input) {
   });
   if (!vision.ok)
     throw new Error(vision.error);
+  const selectsMap = selectsDigestMap(input.select);
+  if (input.depth !== undefined) {
+    if (!Number.isInteger(input.depth) || input.depth < 0) {
+      throw new Error("depth must be a non-negative integer");
+    }
+    if (!selectsMap)
+      throw new Error("depth requires the map facet");
+  }
   const args = [];
   if (input.readseekDir !== undefined)
     args.push("--readseek-dir", input.readseekDir);
@@ -659,6 +674,7 @@ function buildDigestArgs(input) {
   pushOptionalString(args, "--at", input.at);
   pushOptionalNumber(args, "--end", input.end);
   pushOptionalNumber(args, "--limit", input.limit);
+  pushOptionalNumber(args, "--depth", input.depth);
   pushOptionalString(args, "--language", input.language);
   pushOptionalString(args, "--vision-mode", input.visionMode);
   pushOptionalString(args, "--vision-level", input.visionLevel);
@@ -791,9 +807,9 @@ function resolveReadSeekBinaryFromPackages(resolver = resolveFromPackage, option
   const platformPackage = READSEEK_PLATFORM_PACKAGES[key];
   if (!platformPackage) {
     const supported = Object.keys(READSEEK_PLATFORM_PACKAGES).join(", ");
-    throw new Error(`@jarkkojs/readseek ships no binary for ${key}; it supports ${supported}`);
+    throw new Error(`@jarkkojs/readseek-api ships no binary for ${key}; it supports ${supported}`);
   }
-  const metaPackage = options.metaPackage ?? "@jarkkojs/readseek";
+  const metaPackage = options.metaPackage ?? "@jarkkojs/readseek-api";
   const metaPackageJson = resolve(`${metaPackage}/package.json`);
   const metaPackageDir = path.dirname(metaPackageJson);
   let packageJsonPath;
@@ -1752,6 +1768,7 @@ function createReadSeekTools(imagePolicy) {
       at: tool2.schema.string().optional().describe(PARAM_DESCRIPTIONS.at),
       end: tool2.schema.number().int().positive().optional().describe(PARAM_DESCRIPTIONS.end),
       limit: tool2.schema.number().int().positive().optional().describe(PARAM_DESCRIPTIONS.limit),
+      depth: tool2.schema.number().int().nonnegative().optional().describe(PARAM_DESCRIPTIONS.digestDepth),
       language: tool2.schema.string().optional().describe(PARAM_DESCRIPTIONS.languageOverride),
       visionMode: tool2.schema.enum(IMAGE_MODES).optional().describe(PARAM_DESCRIPTIONS.visionModeDigest),
       visionLevel: tool2.schema.enum(VISION_LEVEL_VALUES).optional().describe(PARAM_DESCRIPTIONS.visionLevel)
@@ -1771,6 +1788,7 @@ function createReadSeekTools(imagePolicy) {
         at: input.at,
         end: input.end,
         limit: input.limit,
+        depth: input.depth ?? (select.split(",").some((facet) => facet.trim() === "map") ? DEFAULT_DIGEST_MAP_DEPTH : undefined),
         language: input.language,
         visionMode,
         visionLevel,

package/package.json

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