
arkts-vscode
工具VSCode 鸿蒙 ArkTS 开发插件,提供代码补全、跳转定义、codelinter 代码检测等功能,是华为 DevEco Studio 之外的轻量级 HarmonyOS 开发方案
arktsharmonyosvscodeide鸿蒙arkuiohosplugin
详细文档
arkts-vscode — VSCode 鸿蒙 ArkTS 开发插件#
arkts-vscode 是由社区开发的 VSCode 鸿蒙 ArkTS 开发插件,为 HarmonyOS / OpenHarmony 应用和小程序开发提供代码补全、跳转定义、代码诊断等核心能力。截至 2026-08,项目在 GitHub 上获得 861 stars / 70 forks,MIT 协议开源,持续活跃迭代。
资源概述#
华为官方提供的 HarmonyOS 开发工具是 DevEco Studio(基于 IntelliJ),但许多开发者更习惯 VSCode 的轻量体验。arkts-vscode 填补了这一空白,让开发者在 VSCode 中也能获得 ArkTS/ArkUI 的智能提示和代码检查能力。
核心能力#
- 代码补全:ArkTS 类型、ArkUI 组件名、API 方法名自动补全
- 跳转定义:支持 Go to Definition / Find All References
- CodeLinter 检测:实时检测 ArkTS 代码错误和警告
- Hover 提示:悬停查看类型信息和文档
- 格式化:ArkTS 代码格式化支持
- 代码片段:常用 ArkUI 组件模板
设计规范#
鸿蒙 ArkTS 语法特性#
arkts-vscode 针对以下 ArkTS 独有语法提供智能支持:
- @Entry / @Component 装饰器:页面和组件声明
- @State / @Prop / @Link:状态管理装饰器
- build() 方法:ArkUI 声明式 UI 描述
- 链式调用:
.width().height().backgroundColor()等 UI 属性链 - @Builder / @Styles / @Extend:UI 复用和样式扩展
项目结构识别#
MyApp/
├── entry/src/main/ets/ # ArkTS 源码
│ ├── entryability/ # UIAbility 入口
│ └── pages/ # 页面组件
├── oh-package.json5 # 依赖配置
├── build-profile.json5 # 构建配置
└── module.json5 # 模块配置
开发指南#
快速上手#
- 在 VSCode 扩展市场搜索 "arkts" 安装
- 用 VSCode 打开 HarmonyOS 工程(DevEco Studio 创建的工程兼容)
- 打开
.ets文件即可获得补全和检查
与 DevEco Studio 对比#
| 能力 | DevEco Studio | arkts-vscode |
|---|---|---|
| 代码补全 | ✅ 完整 | ✅ 基本完整 |
| 模拟器/真机调试 | ✅ 内置 | ❌ 需配合 hdc 命令 |
| 可视化预览 | ✅ Previewer | ❌ 不支持 |
| 编译构建 | ✅ 内置 | ❌ 需命令行 hvigorw |
| 轻量启动速度 | ❌ 较重 | ✅ 极快 |
| 远程开发 | ❌ | ✅ SSH Remote 兼容 |
最佳场景#
- 快速代码查看:Clone 仓库后快速浏览 ArkTS 代码
- 远程开发:通过 VSCode Remote-SSH 在服务器上开发鸿蒙应用
- CI/CD 集成:在 CI 中使用 codelinter 检测代码质量
- 学习鸿蒙:轻量入门,不需要安装庞大的 DevEco Studio
常见陷阱#
- 无模拟器调试:arkts-vscode 不包含模拟器和真机调试功能,调试仍需 DevEco Studio 或 hdc 命令行
- API 版本差异:HarmonyOS NEXT(API 12+)与 OpenHarmony API 有差异,插件提示基于已安装的 SDK
- hvigorw 构建依赖:编译/打包仍需通过命令行执行
hvigorw assembleHap - Previewer 不可用:可视化预览需要 DevEco Studio 的 Previewer 组件
生态资源#
- 华为开发者文档:HarmonyOS 开发文档
- DevEco Studio:华为官方 IDE 下载
- OpenHarmony:开源鸿蒙项目
- ArkTS 语言规范:ArkTS 语法介绍
版本更新#
- 2026-08:持续迭代,支持 ArkTS 最新语法特性,codelinter 规则更新
- 2026-06:增强 ArkUI 组件补全能力,新增 @Extend/@Styles 智能提示
- 2025-12:适配 HarmonyOS NEXT API 12+,优化跳转性能