opencode-readseek 0.7.6 → 0.7.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +30 -32
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -2,8 +2,8 @@
2
2
 
3
3
  <img alt="Screenshot of OpenCode running opencode-readseek" src="screenshot.png" width="800">
4
4
 
5
- `opencode-readseek` exposes ReadSeek's hash-anchored text tools and structural
6
- code navigation as OpenCode tools.
5
+ `opencode-readseek` adds ReadSeek's anchored file tools, structural search, and
6
+ symbol navigation to OpenCode.
7
7
 
8
8
  ## Installation
9
9
 
@@ -15,36 +15,33 @@ Add the plugin to `opencode.json`:
15
15
  }
16
16
  ```
17
17
 
18
- OpenCode installs the package and its supported-platform `@jarkkojs/readseek`
19
- binary dependency with Bun at startup.
18
+ OpenCode installs the package and its platform-specific `@jarkkojs/readseek`
19
+ binary dependency with Bun.
20
20
 
21
21
  ## Tools
22
22
 
23
- - `readseek_read`: read text with `LINE:HASH` anchors; PDFs select one page by
24
- default and accept an explicit page.
25
- - `readseek_edit`: apply line, range, and insertion edits with fresh `LINE:HASH` anchors.
26
- - `readseek_write`: create or replace a complete text file.
27
- - `readseek_grep`: plain-text or regular-expression search with anchored results.
28
- - `readseek_map`: generate a structural symbol map.
29
- - `readseek_search`: AST-pattern search.
30
- - `readseek_def`, `readseek_refs`, `readseek_hover`: symbol navigation.
31
- - `readseek_rename`: apply a verified rename by default; `apply: false` returns a dry-run plan.
32
- - `readseek_check`: parse diagnostics.
33
- - `readseek_view`: create or reuse a PDF index, return its overview, or narrow
34
- it by page, node, kind, or depth.
35
-
36
- The plugin requests OpenCode read, grep, external-directory, and edit permissions
37
- as needed. File changes invalidate remembered anchors. Compaction context records
38
- paths with fresh anchors and summaries of pending dry-run rename plans. Text reads
39
- return at most 2,000 lines by default.
40
-
41
- The plugin also instructs OpenCode to prefer ReadSeek's anchored read, edit,
42
- write, and rename tools over built-in file mutation tools while leaving the
43
- built-ins available as fallbacks.
23
+ - `readseek_read`: reads anchored text; PDFs select one page by default.
24
+ - `readseek_edit`: applies hash-verified edits to existing text files.
25
+ - `readseek_write`: creates or replaces complete files.
26
+ - `readseek_grep`: searches text or regular expressions and returns anchors.
27
+ - `readseek_map`, `readseek_search`: map symbols and search AST patterns.
28
+ - `readseek_def`, `readseek_refs`, `readseek_hover`: navigate symbols.
29
+ - `readseek_rename`: applies verified renames by default. Set `apply: false` for a
30
+ dry run.
31
+ - `readseek_check`: reports parse diagnostics.
32
+ - `readseek_view`: indexes a PDF or narrows an existing index by page, node, kind,
33
+ or depth.
34
+
35
+ The plugin requests read, grep, external-directory, and edit permissions as needed.
36
+ File changes invalidate remembered anchors. Compaction state retains fresh paths
37
+ and pending rename plans. Text reads return at most 2,000 lines by default.
38
+
39
+ OpenCode is instructed to prefer ReadSeek's read, edit, write, and rename tools;
40
+ built-in tools remain available as fallbacks.
44
41
 
45
42
  ## Configuration
46
43
 
47
- Pass options with OpenCode's plugin tuple form:
44
+ Pass options with OpenCode's plugin tuple syntax:
48
45
 
49
46
  ```json
50
47
  {
@@ -52,12 +49,13 @@ Pass options with OpenCode's plugin tuple form:
52
49
  }
53
50
  ```
54
51
 
55
- `imageMode` defaults to `"auto"`: it exposes `none`, `all`, `ocr`, `caption`, and
56
- `objects`. `"on"` omits `none`; `"off"` skips image/PDF files. Omitting
57
- `image` also skips visual files.
52
+ `imageMode` defaults to `"auto"`, exposing `none`, `all`, `ocr`, `caption`, and
53
+ `objects`. `"on"` omits `none`; `"off"` skips images and PDFs. Omitting `image`
54
+ also skips visual files.
58
55
 
59
56
  ## Licensing
60
57
 
61
- This package uses the
62
- [Apache-2.0 license](https://github.com/jarkkojs/readseek/blob/main/LICENSE-APACHE-2.0).
63
- `@jarkkojs/readseek` declares `Apache-2.0 AND LGPL-2.1-or-later`.
58
+ `opencode-readseek` is licensed under
59
+ [Apache-2.0](https://github.com/jarkkojs/readseek/blob/main/LICENSE-APACHE-2.0).
60
+ `@jarkkojs/readseek` is licensed separately under
61
+ `Apache-2.0 AND LGPL-2.1-or-later`.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "opencode-readseek",
3
- "version": "0.7.6",
3
+ "version": "0.7.8",
4
4
  "description": "OpenCode plugin for readseek-backed structural code navigation",
5
5
  "type": "module",
6
6
  "main": "./index.ts",
@@ -30,7 +30,7 @@
30
30
  "node": ">=20.0.0"
31
31
  },
32
32
  "dependencies": {
33
- "@jarkkojs/readseek": "^0.7.6",
33
+ "@jarkkojs/readseek": "^0.7.8",
34
34
  "@opencode-ai/plugin": "^1.17.20"
35
35
  },
36
36
  "devDependencies": {