Skip to content

Update opencode config filename - #635

Merged
hongyi-chen merged 4 commits into
warpdotdev:mainfrom
x-n2o:patch-1
Sep 9, 2026
Merged

hongyi-chen merged 4 commits into
warpdotdev:mainfrom
x-n2o:patch-1

Conversation

@x-n2o

@x-n2o x-n2o commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

Summary

Updated the OpenCode configuration filename reference in the documentation from opencode.json to opencode.jsonc to match support for JSON with comments.

Related issues

Closes #636

Validation

Verified that the documentation file src/content/docs/agents/cli-agents/opencode.mdx correctly reflects the opencode.jsonc filename used by the plugin configuration.

Screenshots

None

Follow-ups

None

@cla-bot

cla-bot Bot commented Aug 26, 2026

Copy link
Copy Markdown

Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have the users @x-n2o on file. In order for us to review and merge your code, each contributor must visit https://cla.warp.dev to read and agree to our CLA. Once you have done so, please comment @cla-bot check to trigger another check.

@vercel

vercel Bot commented Aug 26, 2026

Copy link
Copy Markdown

@x-n2o is attempting to deploy a commit to the warpdotdev Team on Vercel.

A member of the Team first needs to authorize it.

@warp-for-oss

warp-for-oss Bot commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

@x-n2o

Every PR must be linked to a same-repo issue before Oz can review it.

Next step: open or find a same-repo issue describing this change, then link it to this PR by adding Closes #123 to the PR description (or using the "Development" sidebar on GitHub). A maintainer will mark the issue ready-to-implement when it is ready. Once it is marked, comment /warp-agent-review to re-trigger review.

See the contribution guidelines for the full readiness model.

Powered by Oz

warp-for-oss[bot]
warp-for-oss Bot previously requested changes Aug 26, 2026

@warp-for-oss warp-for-oss Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@x-n2o

Every PR must be linked to a same-repo issue before Oz can review it.

Next step: open or find a same-repo issue describing this change, then link it to this PR by adding Closes #123 to the PR description (or using the "Development" sidebar on GitHub). A maintainer will mark the issue ready-to-implement when it is ready. Once it is marked, comment /warp-agent-review to re-trigger review.

See the contribution guidelines for the full readiness model.

Powered by Oz

@x-n2o

x-n2o commented Aug 26, 2026

Copy link
Copy Markdown
Contributor Author

@cla-bot check

@cla-bot cla-bot Bot added the cla-signed label Aug 26, 2026
@cla-bot

cla-bot Bot commented Aug 26, 2026

Copy link
Copy Markdown

The cla-bot has been summoned, and re-checked this pull request!

@rachaelrenk

Copy link
Copy Markdown
Contributor

opencode.json and opencode.jsonc are both valid per OpenCode's own docs, so there's no factual error to fix here. Furthermore, the code sample right below the changed line is plain JSON with no comments ({"plugin": ["@warp-dot-dev/opencode-warp"]}), so .json is actually the more accurate filename to pair with that snippet. Switching to .jsonc without adding a comment to the example is inconsistent. I'd recommend closing unless there's a concrete argument for the change -- @hongyi-chen thoughts from an internal perspective?

@hongyi-chen

Copy link
Copy Markdown
Collaborator

Thanks again for the contribution here, @x-n2o!

Since OpenCode supports both opencode.json and opencode.jsonc, would you be open to updating the docs to mention both rather than replacing one with the other? Something like opencode.json / opencode.jsonc would make it clear that either format is supported.

If you’re up for making that change, happy to keep this open!

Copilot AI lite review requested due to automatic review settings September 9, 2026 09:05
@x-n2o

x-n2o commented Sep 9, 2026

Copy link
Copy Markdown
Contributor Author

Thanks again for the contribution here, @x-n2o!

Since OpenCode supports both opencode.json and opencode.jsonc, would you be open to updating the docs to mention both rather than replacing one with the other? Something like opencode.json / opencode.jsonc would make it clear that either format is supported.

If you’re up for making that change, happy to keep this open!

Thanks @hongyi-chen — updated the PR to mention both opencode.jsonc and opencode.json, and direct users to their existing configuration file.

For context, OpenCode began automatically creating a global opencode.jsonc when no global config exists in anomalyco/opencode#26992, merged May 12, resolving anomalyco/opencode#4208. That was the motivation for the original change: helping users find the file OpenCode creates for them.

Both extensions remain supported. The existing snippet also works unchanged with either filename, since comments are optional in JSONC.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The change is small, scoped, and improves filename accuracy; only a minor wording suggestion remains.

Pull request overview

This PR updates the OpenCode notifications documentation to reflect that OpenCode supports a JSON-with-comments config filename (opencode.jsonc), so readers aren’t pointed only at opencode.json.

Changes:

  • Updated the notification plugin setup instruction to reference opencode.jsonc (and also mentions opencode.json).
File summaries
File Description
src/content/docs/agents/cli-agents/opencode.mdx Updates the OpenCode notification plugin setup text to include the JSONC config filename.
Review details
  • Files reviewed: 1/1 changed files
  • Comments generated: 1
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread src/content/docs/agents/cli-agents/opencode.mdx Outdated
x-n2o and others added 3 commits September 9, 2026 10:22
@hongyi-chen
hongyi-chen dismissed warp-for-oss[bot]’s stale review September 9, 2026 18:10

Requirement satisfied: this PR is linked to same-repo issue #636 (Closes #636), which is now labeled ready-to-implement. Dismissing the stale pre-link review; PR has maintainer approval.

@hongyi-chen
hongyi-chen merged commit 7d17c6d into warpdotdev:main Sep 9, 2026
6 of 7 checks passed
@x-n2o
x-n2o deleted the patch-1 branch September 9, 2026 19:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: mention both OpenCode configuration filenames in notification setup

4 participants