docs: align adapter contribution example with the JavaScript adapter layer#2017
Open
yixin-1024 wants to merge 1 commit into
Open
docs: align adapter contribution example with the JavaScript adapter layer#2017yixin-1024 wants to merge 1 commit into
yixin-1024 wants to merge 1 commit into
Conversation
…layer The "Create a file like clis/<site>/<command>.ts" example predates jackwener#928, which converted the entire adapter layer from TypeScript to JavaScript. The repo now ships 0 .ts and 1259 .js built-in adapters, so a contributor following the doc creates a file in the wrong format. Update the example to JavaScript (keeping a pointer to the still-supported TypeScript path), and fix the adapter test command, which pointed at src/ rather than the adapter's own clis/ test file. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
What
The contributing guide's adapter example still tells contributors to create a
.tsfile:But #928 (refactor(adapters): convert adapter layer from TypeScript to JavaScript) migrated the entire adapter layer to JS. The current tree has 0
.tsand 1259.jsbuilt-in adapters, so anyone following the doc authors a file in a format that doesn't match any existing adapter.Changes (
docs/developer/contributing.md)clis/<site>/<command>.jsfilename,```javascriptfence, and drop the: anytype annotation.ts-adapter), so the capability isn't lost.npx vitest run src/<target>.test.tstonpx vitest run clis/<site>/<command>.test.js— adapter tests live underclis/, and fix: include adapter tests in default npm test #969 already wires them intonpm test.Docs-only; no code or behavior change.