vk-unicloud 快速开发框架

# VK 框架快速开发辅助工具（推荐）

作者：VK

这是一款提升开发效率的开发辅助工具，未来会新增更多的实用功能。

插件 Q 群: 22466457 如有问题或建议可以在群内讨论。

# 安装方法

直接导入插件到 HBX 即可

插件安装地址 (opens new window)

# 更新

点击 HBX 上方菜单【工具】- 【插件安装】找到插件，点击【升级】

# 卸载

点击 HBX 上方菜单【工具】- 【插件安装】找到插件，点击【卸载】

# 功能列表

# 初始化 Agent 配置

用于生成 AI 编程工具需要的项目环境配置，适用于插件 0.13.0 及以上版本。

使用方式

  1. 将 VK 框架文档仓库 (opens new window) 导入到与当前项目相同的父目录下，保留目录名 vk-unicloud-docs。
  2. 在 HBuilderX 项目管理器中右键 VK 框架项目名，选择【VK】-【初始化 Agent 配置】。也可以在项目根目录的 AGENTS.md 文件或该文件的代码编辑器中右键执行。
  3. 初始化完成后，点击【查看】检查生成或更新的 AGENTS.md。

工具会自动识别 uniCloud 目录、router 主函数名和文档根目录，写入项目根目录的 AGENTS.md，并创建 CLAUDE.md 或补充 @AGENTS.md 引用。支持重复执行以更新环境信息，并保留已有的其他规则。

菜单仅在项目包含 uni_modules/vk-unicloud/ 时显示。项目根目录的 app.config.js 需配置有效的 functionName。旧版【初始化环境变量】已由此功能替代；旧文件的处理方式、配置示例及不同 AI 工具的使用方法见 AI 编程 - 初始化 Agent 配置。

# 初始化项目配置文件

用于在项目根目录快速补充常用的 Git、Prettier、HBuilderX 格式化及 npm 发布配置文件。插件 0.13.0 起，原【初始化项目文件】菜单更名为【初始化项目配置文件】。

使用方式

  1. 在 HBuilderX 项目管理器中右键项目根目录，选择【VK】-【初始化项目配置文件】。
  2. 在弹窗中勾选需要添加的文件。所有文件默认勾选，推荐文件带有【推荐】标识，项目中已有的文件会显示“已存在，将跳过”。
  3. 点击【添加】，完成后弹窗会显示新建和跳过的文件数量及明细。

至少需要选择一个文件。右键菜单仅在项目缺少 .gitattributes、.gitignore、.prettierignore 或 prettier.config.js 中的任意一个文件时显示。

支持初始化的文件

文件 推荐 用途
.gitattributes 是 统一 Git 仓库中文本及脚本文件的换行符，减少跨平台差异。
.gitignore 是 指定 Git 无需跟踪的依赖、构建产物、缓存和本地配置文件。
.prettierignore 是 指定 Prettier 无需格式化的依赖、构建产物、第三方模块和静态资源。
prettier.config.js 是 配置 Prettier 代码格式化规则，统一项目代码风格。
.jsbeautifyrc 否 未使用 Prettier 时，配置 HBuilderX 内置的代码格式化规则。
.npmignore 否 指定发布 npm 包时需要排除的开发目录、构建产物和本地文件。

初始化过程不会覆盖项目中已有的同名文件，重复执行是安全的。如果写入文件时发生错误，本次操作已经新建的文件会自动回滚，避免项目处于只初始化了一部分的状态。

# 复制页面路径

在.vue 文件右键，点击 VK-复制 vue 页面路径（同时支持在打开的文件代码编辑器中右键）

# 复制 VK 云函数路由框架内的云函数路径

在云函数文件右键，点击 VK-复制云函数路径（同时支持在打开的文件代码编辑器中右键）

# 复制 VK 云函数路由框架内的云对象下的云函数路径

需要先选中云对象内的某个函数名（双击函数名达到选中效果），再右键-VK-复制云函数（云对象）路径

# 新建云函数

在需要新建云函数的目录右键，点击 VK-新建云函数

# 新建云对象

在需要新建云对象的目录右键，点击 VK-新建云对象

# 新建 Dao

在 dao/modules/目录右键，点击 VK-新建 Dao

# 本地运行云函数

右键云函数，点击 VK-本地运行云函数 1

# 本地运行云对象

需要先选中云对象内的某个函数名（双击函数名达到选中效果），再右键-VK-本地运行云函数

# 一键生成云函数加密配置

右键需要加密的云函数根目录下的 package.json 文件，点击 VK-一键生成云函数加密配置

# schema2code（vk-admin 版）

右键需要生成 .schema.json 文件，点击 VK-schema2code

# 快速插入日志

选中某变量名，右键，点击 VK-插入日志

# 一键删除所有 log 类型日志

在编辑器文档内右键，点击 VK-删除所有 log 类型日志

# 一键删除所有类型日志

在编辑器文档内右键，点击 VK-删除所有类型日志

# 开启 VK 框架 d.ts 语法提示

在任意 vue 或 js 文档内右键，点击 VK-开启 VK 框架 d.ts 语法提示（需重启 HBX 才会生效）

效果

  1. 使用本工具内置的 index.d.ts 作为前端语法提示
  2. 使用本工具内置的 vk.d.ts 作为云端语法提示

可以清楚的看到某个方法可接受哪些参数，并且返回值是什么

vk.navigateTo 也能自动提示页面了

# 关闭 VK 框架 d.ts 语法提示

在任意 vue 或 js 文档内右键，点击 VK-关闭 VK 框架 d.ts 语法提示（需重启 HBX 才会生效）

# 快速定位项目（选择项目）

当工作区打开了多个项目时，可以通过此功能快速搜索并切换到目标项目。

使用方式（任选其一）：

  1. 点击 HBX 上方菜单【工具】- 【VK-选择项目（一键搜索）】
  2. 使用快捷键 Ctrl+Alt+P（Mac: Ctrl+Alt+P）

在弹出的搜索框中输入项目名关键字进行搜索，选择目标项目后，会自动打开该项目的 App.vue（或 App.uvue），方便快速定位到项目入口文件。

# 如何设置快捷键

快捷键命令 说明
extension.vk_copyPagePath 复制页面路径
extension.vk_copyFunctionPath 复制云函数路径
extension.vk_copyFunctionPathRunCloudfunctions 本地运行云函数
extension.vk_createCloudfunctions 新建云函数
extension.vk_createDao 新建 Dao 文件
extension.vk_createEncryptConfig 一键生成云函数加密配置
extension.vk_schema2code schema2code（vk-admin 版）
extension.vk_insertLog 快速插入日志
extension.vk_deleteAllLog1 一键删除所有 log 类型日志
extension.vk_deleteAllLog2 一键删除所有类型日志
extension.vk_createCloudObject 新建云对象
extension.vk_pickProject 快速定位项目

点击 hbx 菜单工具、自定义快捷键，将下方代码复制到右侧的[]内


{
  "command": "extension.vk_insertLog",
  "key": "shift+ctrl+l",
  "mac": "shift+cmd+l",
  "when": "editorTextFocus",
  "override":true
},
{
  "command": "extension.vk_deleteAllLog1",
  "key": "shift+ctrl+d",
  "mac": "shift+cmd+d"
},
{
  "command": "extension.vk_deleteAllLog1",
  "key": "ctrl+shift+alt+d",
  "mac": "shift+cmd+d"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

← 代码格式化配置（推荐） →