docs: name tools/ as the canonical custom-tools directory - #41952
Open
andyst-dev wants to merge 1 commit into
Open
docs: name tools/ as the canonical custom-tools directory#41952andyst-dev wants to merge 1 commit into
andyst-dev wants to merge 1 commit into
Conversation
custom-tools.md only documented .opencode/tools/ and ~/.config/opencode/tools/,
but the loader globs {tool,tools}, so the singular tool/ is loaded too. State
explicitly that tools/ is canonical and that tool/ is accepted for backwards
compatibility, matching the convention already documented in config.mdx.
Contributor
|
This PR doesn't fully meet our contributing guidelines and PR template. What needs to be fixed:
Please edit this PR description to address the above within 2 hours, or it will be automatically closed. If you believe this was flagged incorrectly, please let a maintainer know. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #41925
What Problem This Solves
custom-tools.mddocumented only.opencode/tools/and~/.config/opencode/tools/, but the loader globs{tool,tools}(registry.ts), so the singulartool/is loaded too. The documented contract was narrower than the implemented one: someone who guessestool/gets working behavior no page promises, and docs/lint/scaffold tooling treatstool/as wrong when the loader accepts it.Why This Change Was Made
Name
tools/as the canonical directory and state that the singulartool/is accepted for backwards compatibility — matching the convention already documented inconfig.mdx. This resolves the ambiguity without changing loader behavior (both spellings remain valid).Evidence
Doc-only change. Verified the loader glob in
packages/opencode/src/tool/registry.ts:180(Glob.scanSync("{tool,tools}/*.{js,ts}")) and the existing plural-canonical note inconfig.mdx.