Skip to content
Source
Sign inSign up
TanStack/devtools
Open History to see the last commit

skill_tree.yaml

205 lines8.4 KB

1# _artifacts/skill_tree.yaml
2library:
3 name: '@tanstack/devtools'
4 version: '0.10.12'
5 repository: 'https://github.com/TanStack/devtools'
6 description: >
7 Framework-agnostic toolkit for building custom devtools panels via a plugin
8 system with typed event communication. Supports React, Vue, Solid, Preact.
9generated_from:
10 domain_map: '_artifacts/domain_map.yaml'
11 skill_spec: '_artifacts/skill_spec.md'
12generated_at: '2026-03-11'
13​
14skills:
15 # ── Core package: @tanstack/devtools ──
16​
17 - name: 'Devtools app setup'
18 slug: 'devtools-app-setup'
19 type: 'core'
20 domain: 'setup'
21 path: 'packages/devtools/skills/devtools-app-setup/SKILL.md'
22 package: 'packages/devtools'
23 description: >
24 Install TanStack Devtools, pick framework adapter (React/Vue/Solid/Preact),
25 register plugins via plugins prop, configure shell (position, hotkeys,
26 theme, hideUntilHover, requireUrlFlag, eventBusConfig). TanStackDevtools
27 component, defaultOpen, localStorage persistence.
28 sources:
29 - 'TanStack/devtools:docs/quick-start.md'
30 - 'TanStack/devtools:docs/installation.md'
31 - 'TanStack/devtools:docs/configuration.md'
32 - 'TanStack/devtools:docs/overview.md'
33​
34 - name: 'Devtools plugin panel development'
35 slug: 'devtools-plugin-panel'
36 type: 'core'
37 domain: 'plugin-development'
38 path: 'packages/devtools/skills/devtools-plugin-panel/SKILL.md'
39 package: 'packages/devtools'
40 description: >
41 Build devtools panel components that display emitted event data. Listen
42 via EventClient.on(), handle theme (light/dark), use devtools-ui
43 components (JSONTree, buttons, sections). Plugin registration (name,
44 render, id, defaultOpen), lifecycle (mount, activate, destroy), max 3
45 active plugins. Two paths: Solid.js core with devtools-ui or
46 framework-specific panels directly.
47 requires:
48 - 'devtools-event-client'
49 sources:
50 - 'TanStack/devtools:docs/building-custom-plugins.md'
51 - 'TanStack/devtools:docs/plugin-lifecycle.md'
52 - 'TanStack/devtools:docs/plugin-configuration.md'
53 - 'TanStack/devtools:packages/devtools/src/context/devtools-context.tsx'
54​
55 - name: 'Devtools production setup'
56 slug: 'devtools-production'
57 type: 'lifecycle'
58 domain: 'build-production'
59 path: 'packages/devtools/skills/devtools-production/SKILL.md'
60 package: 'packages/devtools'
61 description: >
62 Handle devtools in production vs development. removeDevtoolsOnBuild,
63 /production sub-export, devDependency vs regular dependency, conditional
64 imports, NoOp plugin variants for tree-shaking, non-Vite production
65 exclusion patterns.
66 requires:
67 - 'devtools-app-setup'
68 sources:
69 - 'TanStack/devtools:docs/production.md'
70 - 'TanStack/devtools:packages/devtools-vite/src/remove-devtools.ts'
71​
72 - name: 'Devtools marketplace publishing'
73 slug: 'devtools-marketplace'
74 type: 'lifecycle'
75 domain: 'plugin-development'
76 path: 'packages/devtools/skills/devtools-marketplace/SKILL.md'
77 package: 'packages/devtools'
78 description: >
79 Publish plugin to npm and submit to TanStack Devtools Marketplace.
80 PluginMetadata registry format, plugin-registry.ts, pluginImport
81 (importName, type), requires (packageName, minVersion), framework
82 tagging, multi-framework submissions, featured plugins.
83 requires:
84 - 'devtools-plugin-panel'
85 sources:
86 - 'TanStack/devtools:docs/third-party-plugins.md'
87 - 'TanStack/devtools:packages/devtools/src/tabs/plugin-registry.ts'
88​
89 # ── Event client package: @tanstack/devtools-event-client ──
90​
91 - name: 'Devtools event client'
92 slug: 'devtools-event-client'
93 type: 'core'
94 domain: 'event-communication'
95 path: 'packages/event-bus-client/skills/devtools-event-client/SKILL.md'
96 package: 'packages/event-bus-client'
97 description: >
98 Create typed EventClient for a library. Define event maps with typed
99 payloads, pluginId auto-prepend namespacing, emit()/on()/onAll()/
100 onAllPluginEvents() API. Connection lifecycle (5 retries, 300ms),
101 event queuing, enabled/disabled state, SSR fallbacks, singleton
102 pattern. Unique pluginId requirement to avoid event collisions.
103 sources:
104 - 'TanStack/devtools:docs/event-system.md'
105 - 'TanStack/devtools:docs/building-custom-plugins.md'
106 - 'TanStack/devtools:packages/event-bus-client/src/plugin.ts'
107​
108 - name: 'Devtools strategic instrumentation'
109 slug: 'devtools-instrumentation'
110 type: 'core'
111 domain: 'instrumentation'
112 path: 'packages/event-bus-client/skills/devtools-instrumentation/SKILL.md'
113 package: 'packages/event-bus-client'
114 description: >
115 Analyze library codebase for critical architecture and debugging points,
116 add strategic event emissions. Identify middleware boundaries, state
117 transitions, lifecycle hooks. Consolidate events (1 not 15), debounce
118 high-frequency updates, DRY shared payload fields, guard emit() for
119 production. Transparent server/client event bridging.
120 requires:
121 - 'devtools-event-client'
122 sources:
123 - 'TanStack/devtools:docs/building-custom-plugins.md'
124 - 'TanStack/devtools:docs/bidirectional-communication.md'
125​
126 - name: 'Devtools bidirectional communication'
127 slug: 'devtools-bidirectional'
128 type: 'core'
129 domain: 'event-communication'
130 path: 'packages/event-bus-client/skills/devtools-bidirectional/SKILL.md'
131 package: 'packages/event-bus-client'
132 description: >
133 Two-way event patterns between devtools panel and application.
134 App-to-devtools observation, devtools-to-app commands, time-travel
135 debugging with snapshots and revert. structuredClone for snapshot
136 safety, distinct event suffixes for observation vs commands,
137 serializable payloads only.
138 requires:
139 - 'devtools-event-client'
140 sources:
141 - 'TanStack/devtools:docs/bidirectional-communication.md'
142 - 'TanStack/devtools:packages/event-bus-client/src/plugin.ts'
143​
144 # ── Vite plugin package: @tanstack/devtools-vite ──
145​
146 - name: 'Devtools Vite plugin'
147 slug: 'devtools-vite-plugin'
148 type: 'core'
149 domain: 'build-production'
150 path: 'packages/devtools-vite/skills/devtools-vite-plugin/SKILL.md'
151 package: 'packages/devtools-vite'
152 description: >
153 Configure @tanstack/devtools-vite for source inspection (data-tsd-source,
154 inspectHotkey, ignore patterns), console piping (client-to-server,
155 server-to-client, levels), enhanced logging, server event bus (port,
156 host, HTTPS), production stripping (removeDevtoolsOnBuild), editor
157 integration (launch-editor, custom editor.open). Must be FIRST plugin
158 in Vite config. Vite ^6 || ^7 only.
159 sources:
160 - 'TanStack/devtools:docs/vite-plugin.md'
161 - 'TanStack/devtools:docs/source-inspector.md'
162 - 'TanStack/devtools:packages/devtools-vite/src/plugin.ts'
163 subsystems:
164 - 'Source injection'
165 - 'Console piping'
166 - 'Enhanced logging'
167 - 'Production stripping'
168 - 'Server event bus'
169 - 'Editor integration'
170 references:
171 - 'references/vite-options.md'
172​
173 # ── Utils package: @tanstack/devtools-utils ──
174​
175 - name: 'Devtools framework adapters'
176 slug: 'devtools-framework-adapters'
177 type: 'framework'
178 domain: 'framework-adaptation'
179 path: 'packages/devtools-utils/skills/devtools-framework-adapters/SKILL.md'
180 package: 'packages/devtools-utils'
181 description: >
182 Use devtools-utils factory functions to create per-framework plugin
183 adapters. createReactPlugin/createSolidPlugin/createVuePlugin/
184 createPreactPlugin, createReactPanel/createSolidPanel/createVuePanel/
185 createPreactPanel. [Plugin, NoOpPlugin] tuple for tree-shaking.
186 DevtoolsPanelProps (theme). Vue uses (name, component) not options
187 object. Solid render must be function. Class-based panel factories.
188 requires:
189 - 'devtools-plugin-panel'
190 sources:
191 - 'TanStack/devtools:docs/devtools-utils.md'
192 - 'TanStack/devtools:packages/devtools-utils/src/react/plugin.tsx'
193 - 'TanStack/devtools:packages/devtools-utils/src/vue/plugin.ts'
194 - 'TanStack/devtools:packages/devtools-utils/src/solid/plugin.tsx'
195 - 'TanStack/devtools:packages/devtools-utils/src/preact/plugin.tsx'
196 subsystems:
197 - 'React'
198 - 'Vue'
199 - 'Solid'
200 - 'Preact'
201 references:
202 - 'references/react.md'
203 - 'references/vue.md'
204 - 'references/solid.md'
205 - 'references/preact.md'