当 uni-app 遇见 vscode

发布于 1周前 作者 caililin 来自 Uni-App

当 uni-app 遇见 vscode

uni-app 是一个用 vue 语法来开发小程序、App、H5 的框架,官方推荐的开发工具为 HBuilderX,使用起来有很好的开发体验。

不过,由于 HBuilderX 没有 Linux 版以及很多前端之前已经习惯了 vscode,不想更换编辑器。直接使用 vscode 开发 uni-app,其体验并不是很好。

其实 uni-app 和 vscode 也可以很搭,接下来为大伙带来 vscode 中 uni-app 的正确打开姿势。

CLI 工程

全局安装 vue-cli 3.x(如已安装请跳过此步骤)

npm install -g @vue/cli

通过 CLI 创建 uni-app 项目

vue create -p dcloudio/uni-preset-vue my-project

此时,会提示选择项目模板,初次体验建议选择 hello uni-app 项目模板,如下所示:

CLI 创建项目

在vscode中打开项目

VSCode 打开项目

安装vue语法提示插件vetur

Vetur 插件

CLI 工程默认带了uni-app语法提示和5+App语法提示

语法提示 更多语法提示

安装组件语法提示

npm i @dcloudio/uni-helper-json

组件语法提示 更多组件语法提示

导入 HBuilderX 自带的代码块

从 github 下载 uni-app 代码块,放到项目目录下的 .vscode 目录即可拥有和 HBuilderX 一样的代码块。

代码块 更多代码块 更多代码块

运行项目

npm run dev:%PLATFORM%

发布项目

npm run build:%PLATFORM%

%PLATFORM% 可取值如下:

平台
h5 H5
mp-alipay 支付宝小程序
mp-baidu 百度小程序
mp-weixin 微信小程序
mp-toutiao 头条小程序
mp-qq qq 小程序

CLI 方式参考文档

HBuilderX 工程

HBuilderX 创建的工程默认不带 types 语法提示,在 vscode 中编辑的时候,可以自行安装

初始化npm(如已初始化跳过此步骤)

npm init -y

安装 uni-app 语法提示

npm i @types/uni-app @types/html5plus -D

另外,uni-app 项目下的 manifest.json、pages.json 等文件可以包含注释。vscode 里需要改用 jsonc 编辑器打开。

JSONC 编辑器

关于uni-app插件市场的插件,vscode一样可以使用。

  • 如果这些插件有npm使用方式(如uni-ui),可以用npm
  • 如果作者没提供npm方式,那么下载zip包解压也是可以用的

1 回复

uni-app 遇见 VSCode,这两者结合可以极大地提升开发效率与体验。uni-app 是一个使用 Vue.js 开发所有前端应用的框架,支持编译为 H5、小程序、App 等多个平台。而 VSCode 作为一款流行的代码编辑器,提供了丰富的插件和强大的功能,是开发 uni-app 的理想选择。

以下是如何在 VSCode 中高效开发 uni-app 的一些代码案例和配置步骤:

1. 安装 VSCode 插件

首先,确保你安装了以下 VSCode 插件:

  • Vetur:为 Vue.js 提供语法高亮、代码片段、格式化等功能。
  • ESLint:帮助检测和修复 JavaScript 代码中的问题。
  • Prettier:代码格式化工具,保持代码风格一致。
  • uni-app Snippets:提供 uni-app 相关的代码片段,加速开发。
// 在 VSCode 的 settings.json 中添加以下配置以启用 Prettier
{
  "editor.formatOnSave": true,
  "prettier.singleQuote": true,
  "prettier.semi": false
}

2. 创建和配置 uni-app 项目

使用 HBuilderX 或命令行工具创建 uni-app 项目后,可以在 VSCode 中打开项目文件夹。

3. 配置调试环境

为了在 VSCode 中调试 uni-app,你可以使用 launch.json 配置文件。不过,对于 uni-app,通常更依赖于 HBuilderX 的调试功能,因为它提供了更全面的调试支持,包括真机预览和调试。

但如果你希望在 VSCode 中进行一些基本的调试,比如查看控制台输出,你可以使用以下代码在 main.js 中添加一些日志:

// main.js
import Vue from 'vue'
import App from './App'

Vue.config.productionTip = false

App.mpType = 'app'

const app = new Vue({
    ...App
})
app.$mount()

// 添加日志输出
console.log('uni-app has been mounted')

4. 使用 VSCode 任务

你可以定义 VSCode 任务来运行 uni-app 的构建命令。在 .vscode/tasks.json 中添加以下配置:

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "build uni-app",
      "type": "shell",
      "command": "npm run build",
      "group": {
        "kind": "build",
        "isDefault": true
      },
      "problemMatcher": []
    }
  ]
}

这样,你就可以通过 VSCode 的“终端”->“运行任务”来执行构建命令了。

总结

通过安装必要的插件、配置调试环境以及使用 VSCode 任务,你可以在 VSCode 中高效地开发 uni-app 项目。虽然 uni-app 提供了与 HBuilderX 的深度集成,但 VSCode 的灵活性和插件生态也让它成为了一个值得考虑的替代选项。

回到顶部