Add self-contained CodeReference types file, compat checks, and docs download endpoint - #484
Open
tbuckley wants to merge 3 commits into
Open
Add self-contained CodeReference types file, compat checks, and docs download endpoint#484tbuckley wants to merge 3 commits into
tbuckley wants to merge 3 commits into
Conversation
Deploying evals-pwa with
|
| Latest commit: |
f878479
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://a44dd12b.evals-pwa.pages.dev |
| Branch Preview URL: | https://codex-add-link-for-coderefer.evals-pwa.pages.dev |
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
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.
Motivation
CodeReference-related types so consumers can paste or import definitions without depending on internal$libmodules.Description
src/lib/documentation/codeReferenceTypes.ts, a self-contained, interface-focused TypeScript definitions file that declaresFileReference,CodeReference, prompt/provider shapes,Fs*storage types,JavascriptAssertionArgs, and aGeneratorinterface.src/lib/documentation/codeReferenceTypes.compat.ts, a type-level compatibility file that compares the downloaded doc types against the repo runtime types to catch regressions.Generatorinsrc/lib/storage/runGenerators.ts, addFsProviderinsrc/lib/storage/types.ts, and exportJavascriptAssertionArgsfromsrc/lib/assertions/javascript.ts.src/routes/documentation/code-reference-types/+page.svelteandsrc/routes/documentation/code-reference-types/types/+server.tsto display and serve thecodeReferenceTypes.tsfile, and link it from the main docs (src/routes/documentation/+page.md).Testing
CI=1 npm run testwas executed and all tests passed (integration + unit).npm run check(svelte-check/ type checking) completed with no errors.npm run lint(Prettier / ESLint /tsc --noEmit) completed successfully after formatting and small type adjustments.Codex Task