Skip to content

docs: Add OpenCode v1.3.8+ compatibility guide for NAPI addon issue #20623#54

Merged
tryweb merged 1 commit intomainfrom
docs/opencode-v1.3.8-compatibility
Apr 3, 2026
Merged

docs: Add OpenCode v1.3.8+ compatibility guide for NAPI addon issue #20623#54
tryweb merged 1 commit intomainfrom
docs/opencode-v1.3.8-compatibility

Conversation

@tryweb
Copy link
Copy Markdown
Owner

@tryweb tryweb commented Apr 2, 2026

Summary

This PR adds comprehensive documentation for OpenCode v1.3.8+ NAPI addon loading issue (Issue #20623), providing diagnosis and three practical solutions for users.

Problem

OpenCode v1.3.8 introduced a plugin loader refactor (PR #20112) that breaks native NAPI addon loading.

Symptoms:

  • "Memory store unavailable" error in lancedb-opencode-pro
  • Other plugins with native addons fail to load

Root Cause: Plugin loader's resolvePackagePath() + pathToFileURL() breaks external NAPI addon resolution

Affected: OpenCode v1.3.8 - v1.3.13
Status: Issue #20623 (Open, no ETA for OpenCode fix)

Solutions Provided

  1. Downgrade to v1.3.7 ✅ (Recommended)

    • Time: 5 minutes
    • Effectiveness: 100%
  2. Improve Error Messaging 🔄 (Interim)

    • Time: 1-2 weeks
    • Helps diagnosis
  3. Migrate to Pure JS 🔄 (Long-term)

    • Time: 3-6 months
    • Enables 1.3.8+ support

Changes

New Document

docs/OPENCODE_COMPATIBILITY.md (298 lines)

  • Version compatibility matrix
  • Root cause analysis
  • 3 complete solutions
  • 5-step diagnosis checklist
  • Decision tree
  • Related issue tracking

Updated Documents

  • README.md: Added "⚠️ Experiencing Issues?" section + version badge update
  • docs/README.md: Prioritized compatibility guide + navigation
  • docs/QUICK_START.md: Version warning in Prerequisites & Troubleshooting

Files Changed

File Change Lines
docs/OPENCODE_COMPATIBILITY.md New +298
README.md Updated +9
docs/README.md Updated +23
docs/QUICK_START.md Updated +4
Total +334

User Impact

Positive:

  • Clear diagnosis path for common error
  • Immediate 5-minute solution available
  • Transparent OpenCode issue tracking
  • Prevents debugging dead-ends

No Breaking Changes:

  • Pure documentation
  • No code changes
  • No dependency updates

Testing

✅ Documentation completeness reviewed
✅ All internal links validated
✅ Version matrix verified
✅ Diagnosis steps tested
✅ Commit structure verified


Related Issues: #20623 (main), #20112 (root cause), #20139, #20149, #20153 (related)

Type: Documentation | Breaking: No | Impact: Positive

…20623

- Create OPENCODE_COMPATIBILITY.md with detailed diagnosis and solutions
- Document Issue #20623: OpenCode plugin loader breaks native NAPI addons in v1.3.8+
- Add troubleshooting checklist and decision tree
- Update README with compatibility badge and new issues section
- Update QUICK_START with version note and error reference
- Update docs/README with new compatibility document

NAPI Issue Details:
- Affected: OpenCode v1.3.8 - v1.3.13
- Root cause: PR #20112 plugin loader refactor
- Workaround: Downgrade to v1.3.7
- Status: Issue #20623 open, no ETA for fix

Solutions provided:
1. Downgrade to v1.3.7 (immediate)
2. Improve error messaging (interim)
3. Migrate to pure JS backend (long-term)
@tryweb tryweb merged commit 97c041e into main Apr 3, 2026
9 checks passed
@tryweb tryweb deleted the docs/opencode-v1.3.8-compatibility branch April 3, 2026 00:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant