SuperAPI AI 工具集

vue-expert-js

编程与开发

查看项目

更新于 10-16 14:51

技能介绍

用途

Vue Expert (JavaScript) 是一个面向 Vue 3 应用开发的技能,定位于使用 JavaScript 与 JSDoc 类型标注、而非 TypeScript 来构建项目。它由资深 Vue 专家流程驱动,适用于希望在纯 JavaScript 环境中获得完整类型覆盖率与规范工程结构的开发场景。

主要能力

该技能围绕以下几个方向提供支持:

  • 创建 Vue 3 组件,使用 <script setup>(不带 lang="ts")。
  • 构建 vanilla JS 组合式函数(composables),基于 ref、reactive、生命周期钩子等。
  • 配置 Vite 项目,使用 .mjs 模块扩展名。
  • 搭建路由(Vue Router 4)与状态管理(Pinia)。
  • 通过 JSDoc 提供类型文档,包括 @typedef、@param、@returns、@type,并使用 eslint-plugin-jsdoc 校验类型覆盖率。
  • 使用 Vitest 与 Vue Test Utils 以 JavaScript 文件进行测试。

其知识参考范围涵盖 Vue 3 Composition API、JSDoc、ESM 模块、Pinia、Vue Router 4、Vite、VueUse、Vitest、Vue Test Utils 以及 JavaScript ES2022+。

使用方式

核心工作流程如下:

  1. 设计架构:规划组件结构与组合式函数,并配以 JSDoc 类型注解。
  2. 实现:使用 <script setup>(无 lang="ts"),必要时使用 .mjs 模块。
  3. 标注:添加完整的 JSDoc 注释(@typedef、@param、@returns、@type)以实现完整类型覆盖;随后运行带 JSDoc 插件的 ESLint(eslint-plugin-jsdoc)来验证覆盖率,在继续之前修复任何缺失或格式错误的注解。
  4. 测试:使用 JavaScript 文件通过 Vitest 验证;确认所有公共 API 的 JSDoc 覆盖率;若测试失败,则回到相关组合式函数或组件,修正逻辑或注解,并重新运行直到测试套件通过。

该技能可按上下文加载详细参考文档,例如:JSDoc 类型、组合式函数模式、组件架构、状态管理、测试模式。对于共享的 Vue 概念,则引用 vue-expert 的相应文档(组合式 API、组件、状态管理)。

在实现 Vue 功能时,输出模板包含:带 <script setup>(无 lang 属性)与 JSDoc 类型化 props/emits 的组件文件;针对复杂 prop 或 state 形状的 @typedef 定义;带 @param 与 @returns 注解的组合式函数;以及关于类型覆盖情况的简要说明。

作为 AIX skill pack 的一部分,其面向用户的别名为 aix-vue-expert-js。当用户调用 aix-vue-expert-js 时使用本技能。生成产物写入 .aix/ 目录下;写入前需用 mkdir -p .aix 确保目录存在;.aix/ 中的生成文件默认可能被覆盖;除非明确要求,否则不要将生成文件写入项目根目录。

适用场景

适用于以纯 JavaScript(配合 JSDoc)方式开发 Vue 3 应用的场景,包括组件开发、组合式函数编写、Vite 项目配置、路由与状态管理搭建,以及对应的测试与类型文档维护。

限制

该技能设有明确的约束:

必须遵守:使用组合式 API 与 <script setup>;使用 JSDoc 注释进行类型文档;需要时使用 .mjs 扩展名作为 ES 模块;为每个公共函数标注 @param 与 @returns;对跨文件共享的复杂对象形状使用 @typedef;为响应式变量使用 @type 注解;遵循适配 JavaScript 的 vue-expert 模式。

禁止事项:使用 TypeScript 语法(不得使用 <script setup lang="ts">);使用 .ts 文件扩展名;对公共 API 跳过 JSDoc 类型;在 Vue 文件中使用 CommonJS require();完全忽略类型安全;在同一组件中混用 TypeScript 与 JavaScript 文件。

补充说明

该技能的官方页面暂未提供更多关于收费、价格或平台支持的信息。其描述内容(如组件创建、Vite 配置、路由与状态管理)以技能资料为准,未提及的部分不予补充。