Skip to content

Commit 9688a40

Browse files
committed
fix(vue-devtools): fix jsdoc, bump sherif
1 parent e81d8da commit 9688a40

File tree

5 files changed

+108
-49
lines changed

5 files changed

+108
-49
lines changed

examples/vue/basic/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
"preview": "vite preview"
99
},
1010
"dependencies": {
11-
"@tanstack/devtools": "workspace:*",
12-
"@tanstack/vue-devtools": "workspace:*",
11+
"@tanstack/devtools": "^0.6.22",
12+
"@tanstack/vue-devtools": "^0.1.0",
1313
"@tanstack/vue-query": "^5.90.5",
1414
"@tanstack/vue-query-devtools": "^5.91.0",
1515
"vue": "^3.5.22"
@@ -19,4 +19,4 @@
1919
"typescript": "~5.9.2",
2020
"vite": "^7.1.7"
2121
}
22-
}
22+
}

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
"test:lib": "nx affected --targets=test:lib --exclude=examples/**",
3636
"test:lib:dev": "pnpm test:lib && nx watch --all -- pnpm test:lib",
3737
"test:pr": "nx affected --targets=test:format,test:eslint,test:sherif,test:knip,test:lib,test:types,test:build,build",
38-
"test:sherif": "sherif -p @tanstack/query-example-vue-basic",
38+
"test:sherif": "sherif",
3939
"test:types": "nx affected --targets=test:types --exclude=examples/**",
4040
"watch": "pnpm run build:all && nx watch --all -- pnpm run build:all"
4141
},
@@ -72,7 +72,7 @@
7272
"prettier": "^3.6.2",
7373
"prettier-plugin-svelte": "^3.4.0",
7474
"publint": "^0.3.13",
75-
"sherif": "^1.6.1",
75+
"sherif": "^1.7.0",
7676
"size-limit": "^11.2.0",
7777
"tinyglobby": "^0.2.15",
7878
"typescript": "~5.9.2",
@@ -85,4 +85,4 @@
8585
"@tanstack/solid-devtools": "workspace:*",
8686
"@tanstack/devtools-vite": "workspace:*"
8787
}
88-
}
88+
}

packages/vue-devtools/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,4 +55,4 @@
5555
"eslint-plugin-vue": "^10.5.1",
5656
"vue": "^3.5.22"
5757
}
58-
}
58+
}

packages/vue-devtools/src/types.ts

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,23 @@ export type TanStackDevtoolsVuePlugin = Omit<
1717
export interface TanStackDevtoolsVueInit {
1818
/**
1919
* Array of plugins to be used in the devtools.
20-
* Each plugin should have a `render` function that returns a Vue component
20+
* Each plugin should have a `render` prop that returns a Vue component
2121
*
2222
* Example:
2323
* ```vue
24-
* <TanStackDevtools
25-
* plugins={[
26-
* {
27-
* id: "your-plugin-id",
28-
* name: "Your Plugin",
29-
* render: <CustomPluginComponent />,
30-
* }
31-
* ]}
32-
* />
24+
* <script setup lang="ts">
25+
* import { TanStackDevtools } from '@tanstack/vue-devtools'
26+
* import { VueQueryDevtoolsPanel } from '@tanstack/vue-query-devtools'
27+
*
28+
* const plugins = [{ name: 'Vue Query', component: VueQueryDevtoolsPanel }]
29+
* </script>
30+
*
31+
* <template>
32+
* <TanStackDevtools
33+
* :eventBusConfig="{ connectToServerBus: true }"
34+
* :plugins="plugins"
35+
* />
36+
* </template>
3337
* ```
3438
*/
3539
plugins?: Array<TanStackDevtoolsVuePlugin>

pnpm-lock.yaml

Lines changed: 87 additions & 32 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)