Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/nuxt/nuxt.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
// only to resolve runtime plugin types on local, not shipped
declare module '#imports' {
export { defineNuxtPlugin, useRuntimeConfig } from 'nuxt/app'
}
8 changes: 5 additions & 3 deletions packages/nuxt/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,9 @@
"sideEffects": false,
"exports": {
".": "./dist/index.mjs",
"./runtime/plugin.client": "./dist/runtime/plugin.client.mjs",
"./package.json": "./package.json"
},
"types": "./dist/index.d.ts",
"types": "./dist/index.d.mts",
"files": [
"dist"
],
Expand All @@ -32,11 +31,14 @@
"watch": "tsdown --watch"
},
"peerDependencies": {
"@nuxt/kit": "^3.0.0 || ^4.0.0",
"@nuxt/kit": "^3.0.0 || ^4.0.0 || ^5.0.0-0",
"devframe": "workspace:*"
},
"devDependencies": {
"@nuxt/kit": "catalog:build",
"@types/node": "catalog:types",
"devframe": "workspace:*",
"nuxt": "catalog:build",
"tsdown": "catalog:build"
}
}
8 changes: 7 additions & 1 deletion packages/nuxt/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,14 @@ export default defineNuxtModule<DevframeNuxtModuleOptions>({
baseURL: options.baseURL,
}

const runtimeDir = resolve('./runtime')

nuxt.hook('prepare:types', ({ references }) => {
references.push({ path: resolve(runtimeDir, 'types') })
})

addPlugin({
src: resolve('./runtime/plugin.client'),
src: resolve(runtimeDir, 'plugin.client'),
mode: 'client',
})

Expand Down
24 changes: 12 additions & 12 deletions packages/nuxt/src/runtime/plugin.client.ts
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
import type { DevToolsRpcClient } from 'devframe/client'
import { connectDevframe } from 'devframe/client'
// `#app` is a Nuxt virtual module; types resolve via `@nuxt/schema`.
import { defineNuxtPlugin, useRuntimeConfig } from '#app'
import { defineNuxtPlugin, useRuntimeConfig } from '#imports'

/**
* Nuxt client plugin that calls `connectDevframe()` once on the client
* and provides the RPC client as `$rpc` / `useNuxtApp().$rpc`.
*/
export default defineNuxtPlugin(async () => {
const config = useRuntimeConfig()
const baseURL = (config.public as any)?.devframe?.baseURL ?? './'
const rpc = await connectDevframe({ baseURL })
return {
provide: {
rpc: rpc as DevToolsRpcClient,
},
}
export default defineNuxtPlugin({
async setup() {
const config = useRuntimeConfig()
const baseURL = (config.public as any)?.devframe?.baseURL ?? './'
const rpc = await connectDevframe({ baseURL })
return {
provide: {
rpc: rpc as import('devframe/client').DevToolsRpcClient,
},
}
},
})
6 changes: 4 additions & 2 deletions packages/nuxt/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
"extends": "../../tsconfig.base.json",
"compilerOptions": {
"composite": true,
"lib": ["esnext", "dom"]
}
"lib": ["esnext", "dom"],
"types": ["node"]
},
"include": ["nuxt.d.ts", "src/**/*.ts", "../devframe/src/**/*.ts"]
}
45 changes: 38 additions & 7 deletions packages/nuxt/tsdown.config.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
import fs from 'node:fs/promises'
import { defineConfig } from 'tsdown'

export default defineConfig({
entry: {
'index': 'src/index.ts',
'runtime/plugin.client': 'src/runtime/plugin.client.ts',
},
tsconfig: '../../tsconfig.base.json',
export default defineConfig([{
entry: './src/index.ts',
// tsconfig: '../../tsconfig.base.json',
clean: true,
dts: true,
exports: true,
Expand All @@ -21,4 +19,37 @@ export default defineConfig({
'scule',
],
},
})
}, {
// just transpile the plugin to esm: we don't need the runtime at subpackage exports
entry: {
'runtime/plugin.client': 'src/runtime/plugin.client.ts',
},
outExtensions: () => ({
js: '.js',
}),
platform: 'browser',
clean: false,
dts: false,
exports: false,
deps: {
neverBundle: [
'#imports',
'nuxt/app',
],
},
hooks: {
'build:done': async () => {
// copy types and generate plugin dts
await Promise.all([
fs.cp('src/runtime/types.d.ts', 'dist/runtime/types.d.ts'),
fs.writeFile('dist/runtime/plugin.client.d.ts', `import type { Plugin } from '#app';
import type { DevToolsRpcClient } from 'devframe/client';
declare const plugin: Plugin<{
rpc: DevToolsRpcClient;
}>;
export default plugin;
`, 'utf-8'),
])
},
},
}])
Loading
Loading