HarmonyOS-ArkTS 插件介绍
HarmonyOS-ArkTS 插件，旨在让开发者在 VS Code、Cursor 或 Trae 等 IDE 环境中，也能拥有LSP级的 ArkTS 开发能力。
功能一览
1. 智能编码
- 代码补全：组件名、属性、方法、装饰器等上下文感知的智能补全，支持
module.json5 等配置文件自动补全
- 悬浮提示：鼠标悬停即可查看类型签名、API文档
- 签名帮助：函数调用时自动显示参数列表和类型信息
- 内联提示：在代码中内联显示参数名称和推断类型，帮助快速理解代码意图
2. 代码导航
- 跳转定义：快速跳转到符号的定义位置
- 查找引用：查找符号在项目中的所有引用
- 资源跳转：支持
$r('app.string.xxx') 和 $rawfile('xxx') 资源引用的跳转，可跨模块定位资源文件
- 文档大纲：查看文件中所有类、接口、函数、枚举等结构
- 类型/调用层次：查看类型继承关系和函数调用链
3. 语法高亮
- 语义化高亮：基于语言服务器的语义分析，精确区分
struct、component、decorator、namespace 等 ArkTS 特有语法元素
- JSON5 高亮：为
.json5 配置文件提供语法高亮和图标支持
- 自定义文件图标：
.ets、.json5 文件在编辑器和资源管理器中显示专属图标
4. 代码诊断
- 多阶段实时诊断：集成 ArkTS 引擎校验，全面覆盖语法错误和类型错误
- 配置文件校验：对
oh-package.json5、module.json5、build-profile.json5、app.json5 等配置文件进行 JSON Schema 校验
- 依赖检查：自动检测
oh-package.json5 中的依赖是否已安装、版本是否匹配、本地路径是否有效
- 弃用/未使用标记：对已弃用的 API 显示删除线，未使用的变量显示淡化效果
5. 代码重构
6. 代码片段
内置丰富的 ArkTS 代码片段，输入前缀即可快速插入
安装
前置条件
- VSCode 1.75.0或更高版本，支持Fork版本
- DevEco Studio 6.0.0及以上版本
从VScode插件市场上安装
必要配置路径
| 配置项 |
类型 |
说明 |
arkts.deveco.path |
string |
DevEco Studio 安装目录的完整路径 |
示例值：
- Windows:
D:\Program Files\Huawei\DevEco Studio
- macOS:
/Applications/DevEco-Studio.app
本插件初次安装时会出现弹窗提示输入DevEco Studio 安装根目录，即只需选到包含 sdk 文件夹的那一层即可。
若没有看见弹窗 或 需要更改配置路径：
- 点击 VS Code 已安装插件找到HarmonyOS-ArkTS 点击右下角 ⚙️，选择 设置 (Settings)，或者使用快捷键 Ctrl +进入设置页；
- 在Setting设置中找到ArkTS Language Server > Arkts > Deveco: Path 重新配置对应路径；
使用指南
快速开始
- 使用 VSCode 打开一个 HarmonyOS / OpenHarmony 项目（项目根目录应包含
build-profile.json5 或 oh-package.json5）
- 插件会自动激活并启动语言服务器，右下角可观察初始化进度
- 初始化完成后即可享受完整的语言服务功能
可用命令
打开命令面板，输入以下命令：
| 命令 |
说明 |
ArkTS: Restart Language Server |
重启语言服务器（遇到异常时使用） |
查看诊断日志
当遇到问题时，可以通过 LSP 协议日志排查：
- 在output页签中选择 ArkTS Language Server
- 查看客户端与服务器之间的通信日志
项目自动检测
插件会自动检测工作区中的 HarmonyOS 项目结构：
- 扫描
build-profile.json5 获取模块列表
- 自动识别
entry、feature、library 等常见模块目录
- 支持嵌套项目结构，自动定位有效的项目根目录
- 监听配置文件变更，实时更新模块配置
常见问题
插件未激活？
确保项目根目录包含 build-profile.json5 或 oh-package.json5，这是插件识别 HarmonyOS 项目的标志文件。
语言服务不工作？
- 检查
arkts.deveco.path 是否配置正确
- 确认 DevEco Studio 已安装完整（包含 SDK）
- 尝试执行
ArkTS: Restart Language Server 命令
- 查看 ArkTS Language Server 输出通道的日志信息
配置文件报红但内容正确？
确保使用的是最新版本的 SDK，Schema 校验规则会随 SDK 版本更新。
| |
