@@ -10,10 +10,20 @@ You can check the [TODO list](https://github.com/vitejs/devtools/issues/9) (excl
1010
1111## Setup
1212
13+ Requires ` pnpm@10.x ` .
14+
1315``` bash
1416pnpm install
1517pnpm build # Required: generates Rolldown meta under ./packages/rolldown/node_modules/.rolldown
16- pnpm dev # Start dev server
18+
19+ # Start Rolldown devtools UI
20+ pnpm dev:rolldown
21+ # Start Vite devtools UI
22+ pnpm dev:vite
23+ # Core playground (host app with DevTools overlay)
24+ pnpm play
25+ # Standalone client dev
26+ pnpm play:standalone
1727```
1828
1929** Note** : After pulling latest commits, remove ` ./packages/rolldown/node_modules/.rolldown ` and rebuild to get the latest data format.
@@ -42,8 +52,8 @@ Main entry point and core functionality.
4252
4353Utility library for integration authors.
4454
45- - TypeScript types and interfaces
46- - Utilities for custom docks, views, panels
55+ - TypeScript types and interfaces for docks, views, panels
56+ - ` defineRpcFunction ` and shared state utilities
4757- Event system utilities
4858- RPC client helpers
4959
@@ -66,9 +76,21 @@ Built-in UI panel for Rolldown integration.
6676
6777---
6878
79+ ### ` packages/vite ` - ` @vitejs/devtools-vite `
80+
81+ UI for Vite DevTools (WIP).
82+
83+ ---
84+
85+ ### ` packages/ui ` - ` @vitejs/devtools-ui `
86+
87+ Shared UI components, composables, and UnoCSS preset (` presetDevToolsUI ` ).
88+
89+ ---
90+
6991### ` packages/rpc ` - ` @vitejs/devtools-rpc `
7092
71- RPC layer for component communication .
93+ Typed RPC wrapper over ` birpc ` with WebSocket presets .
7294
7395- RPC client/server implementations
7496- WebSocket presets
@@ -79,6 +101,12 @@ RPC layer for component communication.
79101
80102---
81103
104+ ### ` packages/self-inspect ` - ` @vitejs/devtools-self-inspect `
105+
106+ Meta-introspection — DevTools for the DevTools itself.
107+
108+ ---
109+
82110### ` packages/webext ` - ` @vitejs/devtools-webext `
83111
84112Browser extension (planned for future dev mode). ** Not accepting contributions currently.**
@@ -87,14 +115,16 @@ Browser extension (planned for future dev mode). **Not accepting contributions c
87115
88116## Scripts
89117
90- - ` pnpm build ` - Build all packages
91- - ` pnpm watch ` - Watch mode
92- - ` pnpm dev ` - Dev server
93- - ` pnpm lint ` - ESLint
118+ - ` pnpm build ` - Build all packages (via turbo)
119+ - ` pnpm watch ` - Watch mode for all packages
120+ - ` pnpm play ` - Core playground (host app with DevTools overlay)
121+ - ` pnpm play:standalone ` - Standalone client dev
122+ - ` pnpm dev:rolldown ` - Rolldown UI dev server
123+ - ` pnpm dev:vite ` - Vite UI dev server
124+ - ` pnpm docs ` - VitePress docs dev server
125+ - ` pnpm lint ` - ESLint (pass ` --fix ` to auto-fix)
94126- ` pnpm test ` - Vitest
95- - ` pnpm typecheck ` - Type check
96-
97- Package-specific: ` pnpm -C packages/core run cli ` , ` pnpm -C packages/rolldown run dev `
127+ - ` pnpm typecheck ` - vue-tsc type check
98128
99129## Workflow
100130
@@ -107,5 +137,5 @@ Package-specific: `pnpm -C packages/core run cli`, `pnpm -C packages/rolldown ru
107137
108138- ** core** : CLI in ` cli-commands.ts ` , server in ` server.ts ` , components in ` client/webcomponents/ `
109139- ** kit** : Keep APIs stable, add types for public APIs, consider backward compatibility
110- - ** vite** : Nuxt 3 app, Vue 3 Composition API, test with ` pnpm dev ` after build
140+ - ** vite** : Nuxt 4 app, Vue 3 Composition API, test with ` pnpm dev ` after build
111141- ** rpc** : Keep methods type-safe, document new methods, test client/server
0 commit comments