-
-
Notifications
You must be signed in to change notification settings - Fork 87
fix(kit): restore rpc module augmentation #551
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| import type { DevframeRpcServerFunctions } from '@devframes/hub/types' | ||
|
|
||
| /** | ||
| * Server-side RPC functions exposed by Vite DevTools integrations. | ||
| * | ||
| * Extend this interface with module augmentation to type `rpc.call()`. | ||
| */ | ||
| export interface DevToolsRpcServerFunctions extends DevframeRpcServerFunctions {} |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| import { getDevToolsRpcClient } from '@vitejs/devtools-kit/client' | ||
| import '@vitejs/devtools-kit' | ||
|
|
||
| declare module '@vitejs/devtools-kit' { | ||
| interface DevToolsRpcServerFunctions { | ||
| 'test:get-modules': (filter?: string) => Promise<string[]> | ||
| } | ||
| } | ||
|
|
||
| export async function testRpcAugmentation() { | ||
| const rpc = await getDevToolsRpcClient() | ||
| const modules = await rpc.call('test:get-modules', 'src/') | ||
|
|
||
| modules satisfies string[] | ||
|
|
||
| // @ts-expect-error Unknown RPC names remain rejected. | ||
| await rpc.call('test:unknown') | ||
| // @ts-expect-error Registered RPC arguments remain checked. | ||
| await rpc.call('test:get-modules', 42) | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| import { resolve } from 'node:path' | ||
| import ts from 'typescript' | ||
| import { describe, expect, it } from 'vitest' | ||
|
|
||
| describe('rpc module augmentation', () => { | ||
| it('types getDevToolsRpcClient calls through the kit registry', () => { | ||
| const root = resolve(import.meta.dirname, '..') | ||
| const fixture = resolve(import.meta.dirname, 'fixtures/rpc-augmentation.ts') | ||
| const program = ts.createProgram([fixture], { | ||
| baseUrl: root, | ||
| ignoreDeprecations: '6.0', | ||
| module: ts.ModuleKind.ESNext, | ||
| moduleResolution: ts.ModuleResolutionKind.Bundler, | ||
| noEmit: true, | ||
| paths: { | ||
| '@vitejs/devtools-kit': ['packages/kit/src/index.ts'], | ||
| '@vitejs/devtools-kit/client': ['packages/kit/src/client/index.ts'], | ||
| }, | ||
| skipLibCheck: true, | ||
| strict: true, | ||
| target: ts.ScriptTarget.ESNext, | ||
| }) | ||
| const diagnostics = ts.getPreEmitDiagnostics(program) | ||
| const output = ts.formatDiagnosticsWithColorAndContext(diagnostics, { | ||
| getCanonicalFileName: file => file, | ||
| getCurrentDirectory: () => root, | ||
| getNewLine: () => '\n', | ||
| }) | ||
|
|
||
| expect(output).toBe('') | ||
| }) | ||
| }) | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.