vccs-usage 用于在 Vue 3 项目中使用 vccs 图表库时,检索与具体任务对应的指南。CLI、目录和指南都包含在 vccs npm 包内,应通过消费项目的包管理器运行,使检索结果与应用程序代码使用同一 vccs 版本。文档明确要求不要使用带 @latest 的 npx 或 pnpx,也不要从其他代码检出位置获取指南,因为这些来源可能对应不同的 vccs 版本。
使用时,先在消费项目中执行面向动作的搜索,查询应点名想要的结果、图表或 API,例如:pnpm exec vccs-usage search "show daily activity in a calendar"。若使用其他包管理器,则用它对应的本地执行方式。若已安装的 vccs 不提供该命令,不应下载更新的指南 CLI,而应使用与已安装版本匹配的文档,或升级 vccs。JSON 结果包含指南 id、描述、分类、路径和一个词法得分,该得分是路由得分,并非语义相似度。结果为空或过于宽泛时,可用 pnpm exec vccs-usage list 浏览全部指南。
检索指南时,把选中的图表指南与任务所需的每个共享指南以逗号分隔的 id 一并传入,例如 pnpm exec vccs-usage retrieve "calendar-heatmap,vue-api"。文档要求在实现前始终先检索:目录描述只用于选择指南,不足以编写示例。涉及安装或自动导入时加入 installation;涉及插槽、事件、模型、尺寸或颜色时加入 vue-api;涉及编译期行键或类型化负载时加入 typed-rows;涉及 SSR、截图或精确几何时加入 ssr-testing。若输出被截断,可把命令重定向到文件后读取。
实现与验证阶段,应按检索到的图表数据结构和最小示例进行,不要混用不同图表族的属性,也不要回退到 Recharts 的 render-prop API。完成前应确认从 vccs 导入公共运行时组件,仅将 vccs/nuxt 和 vccs/resolver 用于其文档所述的集成;对照检索到的指南检查每个自定义属性和插槽;在存在类型检查和构建时运行它们;在断言像素、截图或要求完整服务端渲染图表前先检索 ssr-testing;若已安装包拒绝文档中的 API,应检查其版本和随包声明,而不是压制类型错误。