mcpField
T
tanstack-integration-best-practices

tanstack-integration-best-practices

github.com/deckardger开发2292.9k 次安装7 周前更新
代码仓库

关于 tanstack-integration-best-practices

用于整合 TanStack Query、Router 和 Start 的实践指南,重点说明数据流、缓存、类型安全及服务端渲染的协同模式。

主要功能

  1. 01Query 客户端与 Provider 配置
  2. 02Router 与 Query 数据流
  3. 03Mutation 与缓存失效
  4. 04预加载协调
  5. 05SSR 水合与流式查询
  6. 06按请求创建 Query 客户端

适用场景

  1. 01启动 TanStack Start 项目
  2. 02整合 Query 与 Router
  3. 03配置 SSR 查询水合
  4. 04协调 Router 与 Query 缓存

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/deckardger/tanstack-agent-skills --skill tanstack-integration-best-practices

安装后在 Claude Code 中输入/tanstack-integration-best-practices确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

rules/
cache-single-source.md
flow-loader-query-pattern.md
setup-query-client-context.md
ssr-dehydrate-hydrate.md

详细介绍

TanStack 集成最佳实践

有效集成 TanStack Query、Router 和 Start 的指南。这些模式可确保整个技术栈实现最佳数据流、缓存协调和类型安全。

适用场景

  • 搭建新的 TanStack Start 项目
  • 将 TanStack Query 与 TanStack Router 集成
  • 配置带查询水合的 SSR
  • 协调 Router 与 Query 之间的缓存
  • 设置类型安全的数据获取模式

按优先级划分的规则类别

优先级类别规则影响
CRITICAL设置3 条规则基础配置
CRITICALSSR 集成1 条规则Router + Query SSR 设置
HIGH数据流4 条规则正确的数据获取模式
MEDIUM缓存3 条规则性能优化
MEDIUMSSR2 条规则其他 SSR 模式

快速参考

设置(前缀:setup-)
  • setup-query-client-context — 通过 Router 上下文传递 QueryClient
  • setup-provider-wrapping — 正确使用 QueryClientProvider 包装
  • setup-stale-time-coordination — 协调 Router 与 Query 之间的 staleTime
数据流(前缀:flow-)
  • flow-loader-query-pattern — 将 Loader 与 ensureQueryData 配合使用
  • flow-suspense-query-component — 在组件中使用 useSuspenseQuery
  • flow-mutations-invalidation — 协调变更操作与查询失效
  • flow-server-functions-queries — 使用服务端函数作为查询函数
缓存(前缀:cache-)
  • cache-single-source — 让 TanStack Query 管理缓存
  • cache-preload-coordination — 协调 Router 与 Query 之间的预加载
  • cache-invalidation-patterns — 统一的失效模式
SSR 集成(前缀:ssr-)
  • ssr-dehydrate-hydrate — 使用 setupRouterSsrQueryIntegration 自动处理 SSR
其他 SSR(前缀:ssr-)
  • ssr-per-request-client — 为每个请求创建 QueryClient
  • ssr-streaming-queries — 处理查询的流式传输

使用方法

rules/ 目录中的每个规则文件都包含:

  1. 说明 — 此模式为何重要
  2. 错误示例 — 应避免的反模式
  3. 正确示例 — 推荐的实现方式
  4. 上下文 — 何时应用或跳过此规则

完整参考

有关详细指南和代码示例,请参阅 rules/ 目录中的各个规则文件。

评论

支持 Markdown