SuperAPI AI 工具集

query-docs-library-metadata

编程与开发

查看项目

更新于 10-16 02:24

技能介绍

用途

该技能用于在代码生成或集成选型之前,收集权威的上下文信息。它面向 TanStack 生态,帮助使用者在动手写代码或选择集成方案前,先获取准确的库清单与文档内容。

主要能力

  • 查询可用的 TanStack 库列表,输出机器可读的 JSON。
  • 获取指定库的特定文档页面,并支持显式指定文档版本。
  • 在文档中搜索实现目标相关内容,支持按库过滤并输出 JSON。
  • 列出脚手架可用的附加组件(add-ons)及其详情。

使用方式

安装与初始化:

npx @tanstack/cli libraries --json

核心模式:

  1. 在获取文档前先解析有效的库 ID:
npx @tanstack/cli libraries --json
  1. 获取指定文档页面并显式指定版本:
# 语法:tanstack doc <library-id> <path> [--docs-version <version>]
npx @tanstack/cli doc router framework/react/guide/routing
npx @tanstack/cli doc router framework/react/guide/routing --docs-version latest
  1. 搜索文档以定位实现目标:
npx @tanstack/cli search-docs "server functions" --library start --json

常见错误

  • 使用无效的库 ID、版本或路径来获取文档。错误示例:
# 错误:--library 和 --version 不是 doc 的标志;路径不能包含 /docs/ 前缀
npx @tanstack/cli doc --library router --version latest --path /docs/framework/react/guide/routing

正确做法:

# 第 1 步:解析有效的库 ID
npx @tanstack/cli libraries --json
# 第 2 步:使用位置参数获取——先库 ID,再文档路径(不带 /docs/ 前缀)
npx @tanstack/cli doc router framework/react/guide/routing

doc 将 <library> 和 <path> 作为位置参数(而非标志),路径不得包含开头的 /docs/ 段。使用 --docs-version(而非 --version)来固定特定版本。

  • 依赖已弃用的 create 别名进行发现。错误示例:
npx create-tsrouter-app --list-add-ons

正确做法:

npx @tanstack/cli create --list-add-ons --json

旧别名工作流可能产生与当前 CLI 发现行为不一致的混乱输出。

  • 单一命令便利性与集成精确性之间的张力:跳过发现步骤直接运行一次性脚手架命令,往往会锁定看似合理但忽略架构约束的默认值。

适用场景

  • 在生成代码前需要确认可用的 TanStack 库及其有效 ID。
  • 需要按指定版本获取权威文档内容。
  • 需要搜索文档以定位具体实现目标。
  • 需要列出脚手架附加组件及其详情以辅助集成选型。

限制

  • 该技能依赖 @tanstack/cli 命令,具体输出 schema 以实际命令为准。
  • 文档获取需使用有效的库 ID、路径与版本,否则会失败。
  • 关于收费、价格、平台支持范围等信息,资料中暂未提供。