Vue Best Practices 是一套面向 Vue 3 与 TypeScript 开发的规则集合,来源于 yuanxiao0115/agent-skills。其内容以规则表的形式组织,分为能力规则(Capability Rules)与效率规则(Efficiency Rules)两类,每条规则包含规则名、关键词与描述,便于在开发过程中按问题定位对应处理方式。
用途 该技能主要服务于使用 Vue 3、TypeScript、vue-tsc、Volar、Vite 等技术栈的项目,帮助开发者处理类型检查、组件 props、模板校验、模块解析、编辑器性能以及测试相关的问题。
主要能力 能力规则覆盖以下方面:
- extract-component-props:从 .vue 组件中提取类型,涉及获取 props 类型、包装组件、扩展 props、继承 props、ComponentProps。
- vue-tsc-strict-templates:在模板中捕获未定义组件,涉及未定义组件、模板错误、strictTemplates。
- fallthrough-attributes:对透传属性进行类型检查,涉及 fallthrough、$attrs、包装组件。
- strict-css-modules:捕获 CSS Module 类名拼写错误,涉及 css modules、$style、typo。
- data-attributes-config:允许 data-* 属性,涉及 data-*、strictTemplates、attribute。
- volar-3-breaking-changes:修复 Volar 3.0 升级问题,涉及 volar、vue-language-server、editor。
- module-resolution-bundler:修复模块解析错误,涉及 cannot find module、@vue/tsconfig、moduleResolution。
- unplugin-auto-import-conflicts:修复 unplugin 类型冲突,涉及 unplugin、auto-import、types any。
- codeactions-save-performance:修复大型项目保存缓慢问题,涉及 slow save、vscode、performance。
- duplicate-plugin-detection:检测重复插件,涉及 duplicate plugin、vite、vue plugin。
- define-model-update-event:修复 model 更新错误,涉及 defineModel、update event、undefined。
- with-defaults-union-types:修复联合类型默认值,涉及 withDefaults、union type、default。
- deep-watch-numeric:高效监听数组,涉及 watch、deep、array、Vue 3.5。
- vue-directive-comments:控制模板类型检查,涉及 @vue-ignore、@vue-skip、template。
- script-setup-jsdoc:为 script setup 添加 JSDoc,涉及 jsdoc、script setup、documentation。
- vue-router-typed-params:修复路由参数类型,涉及 route params、typed router、unplugin。
效率规则覆盖以下方面:
- hmr-vue-ssr:修复 SSR 应用中的 HMR,涉及 hmr、ssr、hot reload。
- pinia-store-mocking:模拟 Pinia store,涉及 pinia、mock、vitest、store。
使用方式 资料中未提供具体安装命令或调用步骤,暂未提供。
适用场景 适用于 Vue 3 + TypeScript 项目的日常开发、类型检查、编辑器配置、构建配置与单元测试等环节,尤其适合遇到模板类型错误、模块解析失败、编辑器保存缓慢、插件重复、路由参数类型缺失等问题时参考。
限制 资料仅以规则表形式列出规则名、关键词与描述,未提供每条规则的详细示例、配置代码或完整说明;也未提供收费、价格、平台支持范围等信息,暂未提供。