Repository navigation
docs(plugins): align package.json peers with @opencode/plugin - #58862
renjianguojinqianfan wants to merge 1 commit into
Conversation
github-actions
Bot
added
the
needs:compliance
![opencode-agent[bot]](https://avatars.githubusercontent.com/in/1549082?s=60&v=4){kind=small}
There was a problem hiding this comment.
The @opentui/* peer ranges now match what @opencode/plugin declares (>=0.6.8), which fixes the ERESOLVE from #58807. I checked the two added notes against packages/plugin/src/host.ts and both are accurate. Nothing was run because this is docs-only.
Public API: unchanged (documentation only).
One concern, in an inline comment: the exact @opencode/theme pin in the example will itself cause an ERESOLVE as soon as @opencode/plugin@latest moves past 2.1.4.
github-actions
Bot
removed
the
needs:compliance
|
Thanks for updating your PR! It now meets our contributing guidelines. 👍 |
95c90e2 to
161b388
Compare
Fixes anomalyco#58807 The publish example's peer ranges were below what @opencode/plugin requires, so following the docs could fail npm resolution. Use the ranges the package declares. The optional @opencode/theme peer is left out: an exact pin would break the example again on the next release, and only plugins that import the package need it. Also note that a configured directory with no root `server` (or `index`) or `gui-experimental` module is skipped without a warning.
161b388 to
020b05f
Compare
|
Bumping this for review — small docs-only change (2 files, +4/-3), rebased onto The "Publish and load" example in the TUI plugin docs declared The docs also state that a configured plugin directory with no root Heads up that this repo's automated cleanup closes PRs older than a month with fewer than 2 reactions, so it would be swept on 2026-11-25 without review. Happy to adjust anything in the meantime. Thanks! |
Issue for this PR
Closes #58807
Type of change
What does this PR do?
The "Publish and load" example in the TUI plugin docs declared
@opentui/*peer ranges (>=0.6.6) below what@opencode/plugin@latest(2.2.3) requires (>=0.8.0), so following the docs could failnpm installwith ERESOLVE. The example now uses the ranges the package declares.Review feedback noted that
@opencode/themeis optional in@opencode/plugin(only plugins that import it need it) and that the package publishes it as an exact version, so including it in the example would break the example again on the next release; it is left out.The docs also state that a configured plugin directory with no root
server(orindex) orgui-experimentalmodule is skipped without a warning, which is the current behavior.How did you verify your code works?
Checked the example against the published
@opencode/plugin@latestpackage.json— the peer ranges now match exactly, which removes the ERESOLVE from the issue. The silent-skip behavior was read frompackages/core/src/config/plugin/source.ts, which drops a directory with no server or GUI entry without logging. Rebased ontodev, where the same example had drifted back to>=0.6.6. Docs-only otherwise.Screenshots / recordings
N/A (docs only)
Checklist