ArkTS Language Support for Visual Studio Code

为 Visual Studio Code 提供 ArkTS（鸿蒙应用开发语言）完整语言支持：标题栏一键编译/运行、LSP 驱动的补全与诊断，并内置 20 个 MCP 工具，让 Claude、Copilot、Cursor、OpenCode 等 AI 助手直接操作 HarmonyOS 设备和项目。

前置要求

• HarmonyOS DevEco Studio 已安装，hdc 命令在 PATH 中可用
• 在 VS Code 设置中配置 ets.sdkPath（指向 DevEco Studio 下的 sdk/default/openharmony）

重要：ets.sdkPath 未配置时语言服务器不会启动，补全、诊断、跳转等功能不可用。

按需安装：插件体积仅约 545 KB——语言服务器（@arkts/language-server）在首次激活时自动安装到扩展数据目录，编译/运行所需的 devecocli 也会在需要时自动安装，无需手动下载。

快速开始

1. 安装插件
2. 打开设置（Ctrl+,），搜索 ets.sdkPath，填入 OpenHarmony SDK 路径
3. 打开任意 .ets 文件，插件自动激活并安装语言服务器
4. 点击编辑器标题栏的「编译」「运行」按钮，一键构建并运行应用

需要设备操作时，确保已连接 HarmonyOS 设备或模拟器，然后通过命令面板（Ctrl+Shift+P → 输入 ArkTS）访问设备管理功能。

功能特性

一键编译/运行

• 打开 .ets 文件后，编辑器标题栏显示「编译」「运行」按钮
• 编译 → devecocli build；运行 → devecocli run（编译 + 安装 + 启动），输出实时写入 "ArkTS Run" 面板
• 自动识别项目根（从当前文件向上找 oh-package.json5，无需 hvigorw）
• 首次使用自动安装 devecocli（也可通过命令 ArkTS: 安装 deveco-cli 工具 手动安装）

语言支持（LSP 驱动）

• 智能代码补全、悬停文档、实时诊断
• 跳转到定义（F12）、查找引用（Shift+F12）
• 文档格式化
• ArkTS Linter 规范检查（可配置版本或关闭）
• $r() 资源引用验证
• 代码片段：组件模板（entry、comp、compv2）、装饰器（state、local、param）、UI 组件（col、row、list）等
• JSON5 语法高亮（oh-package.json5、module.json5、build-profile.json5 等）

支持的装饰器

• V1：@Entry、@Component、@State、@Prop、@Link、@Provide/@Consume、@Watch、@Observed/@ObjectLink、@Builder/@BuilderParam、@Styles/@Extend 等
• V2（API 12+）：@ComponentV2、@Local、@Param、@Monitor、@Computed、@Provider/@Consumer、@ObservedV2/@Trace 等

MCP 工具（AI 集成，20 个）

AI 助手可直接调用以下工具完成 HarmonyOS 开发任务：

设备管理

项目信息

构建

应用管理

文件传输

日志与诊断

命令与配置

命令

配置项

外部 AI 助手集成

如果需要在 VS Code 以外使用 HarmonyOS 工具（如 Claude Desktop），安装独立的 mcp-harmonyos 包：

npm install -g mcp-harmonyos

将以下配置添加到 Claude Desktop、Cursor 或 OpenCode 的配置文件：

{
  "mcpServers": {
    "harmonyos": {
      "command": "npx",
      "args": ["-y", "mcp-harmonyos"]
    }
  }
}

安装

从 Marketplace 安装

在 VS Code 扩展面板搜索 ArkTS Language Support 并安装。

从 VSIX 安装

1. 下载最新的 .vsix 文件
2. Ctrl+Shift+P → Install from VSIX → 选择文件

开发模式

git clone https://github.com/FadingLight9291117/vscode-arkts.git
cd vscode-arkts
npm install

按 F5 启动调试（使用 npm run watch 监听文件变化）。验证：npm run compile && npm run bundle。

问题排查

语言功能无响应（补全、诊断、跳转）

• 检查 ets.sdkPath 是否已配置并指向有效路径
• 首次激活需自动安装语言服务器（约 1 分钟），可执行 ArkTS: Restart Language Server 重试安装
• 查看"输出"面板 → 选择"ArkTS Language Server"查看错误日志

编译/运行按钮报错 devecocli 未安装

• 插件会自动安装，也可执行 ArkTS: 安装 deveco-cli 工具 手动安装
• 安装失败时可手动执行命令面板提示的 npm install -g @deveco/deveco-cli

MCP 工具报错 hdc not found

• 确认 DevEco Studio 已安装，hdc 在系统 PATH 中
• 在终端执行 hdc list targets 验证

语法高亮不正确

• Ctrl+Shift+P → Reload Window

如遇其他问题，请提交 Issue。

贡献指南

欢迎任何形式的贡献！

常见开发任务：

• 添加 MCP 工具：在 src/mcp/tools/ 新建或编辑文件，在 src/mcp/tools/index.ts 注册
• 修改语法高亮：编辑 syntaxes/arkts.tmLanguage.json
• 添加代码片段：编辑 snippets/arkts/*.json，同步更新 package.json 中的 contributes.snippets

提交 PR：

1. Fork 本仓库，创建功能分支
2. 验证：npm run compile && npm run bundle
3. 提交 Pull Request

相关资源

• HarmonyOS 开发者文档
• ArkTS 语言介绍
• Model Context Protocol (MCP)
• mcp-harmonyos — 独立的 HarmonyOS MCP 服务器

更新日志

详见 CHANGELOG.md。

许可证

MIT — 详见 LICENSE。