Deveco Studio如何设置保存时自动格式化ArkTS代码？

Question

在使用 DevEco Studio 进行 ArkTS 开发时，如何设置代码保存时自动格式化？许多开发者希望在保存文件时自动触发代码格式化，以保持代码风格统一、提升可读性。虽然 DevEco Studio 基于 IntelliJ 平台，支持代码格式化功能，但默认情况下可能未开启“保存时自动格式化”选项。用户需手动配置相关设置，但部分开发者反馈在设置中找不到 ArkTS 对应的格式化选项，或启用后未能生效。此外，与 Prettier 等第三方工具集成时也可能出现冲突。如何正确配置保存时自动格式化 ArkTS 代码，成为常见技术问题。

Answer 1

在 DevEco Studio 中配置 ArkTS 代码保存时自动格式化指南

1. 理解 DevEco Studio 的代码格式化机制

DevEco Studio 是基于 IntelliJ 平台构建的集成开发环境（IDE），专为 HarmonyOS 应用开发设计。它内置了对 ArkTS（Ark TypeScript）语言的支持，包括语法高亮、智能补全和代码格式化功能。代码格式化依赖于 IDE 内部的格式化引擎，该引擎遵循预设的代码风格规则。

默认情况下，DevEco Studio 不开启“保存时自动格式化”功能，开发者需手动启用。此外，ArkTS 作为 HarmonyOS 生态中的专用语言，其格式化配置可能不会像 JavaScript 或 TypeScript 那样显式出现在通用设置中。

2. 启用保存时自动格式化的标准路径

1. 打开 DevEco Studio。
2. 进入 File → Settings（Windows/Linux）或 DevEco Studio → Preferences（macOS）。
3. 导航至 Editor → General → Auto Import，确保启用了“Optimize imports on the fly”和“Add unambiguous imports on the fly”。
4. 转到 Editor → General → Editor Tabs，勾选“Mark modified tabs with asterisk”以便识别未保存文件。
5. 关键步骤：进入 Editor → Actions on Save。
6. 勾选 Reformat code 选项，这将触发保存时格式化。
7. 可选：勾选 Optimize imports 以同时优化导入语句。
8. 点击 Apply 并 OK 保存设置。

3. ArkTS 格式化配置的特殊性分析

尽管上述路径适用于大多数基于 IntelliJ 的语言，但 ArkTS 的格式化规则由 HarmonyOS SDK 提供，并通过 .editorconfig 文件或 IDE 内部的 Code Style for TypeScript 模板控制。由于 ArkTS 继承自 TypeScript，其格式化配置通常映射到 TypeScript 设置中。

若在设置中未找到“ArkTS”专属条目，应检查以下位置：

• Editor → Code Style → TypeScript：调整缩进、空格、换行等规则。
• 确认项目根目录是否存在 .editorconfig 文件，内容示例如下：

[*.ets]
indent_style = space
indent_size = 4
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

4. 常见问题与排查流程

部分开发者反馈启用“保存时格式化”后无效果，可能原因如下：

问题现象	可能原因	解决方案
保存时不格式化	未启用 Actions on Save	检查设置中是否勾选 Reformat code
格式化规则不符合预期	使用了默认 TypeScript 规则	在 Code Style → TypeScript 中自定义规则
与 Prettier 冲突	Prettier 插件优先级更高	禁用 Prettier 或配置执行顺序
仅部分文件生效	文件类型未被识别为 ArkTS	确认文件扩展名为 .ets 且关联正确

5. 与第三方工具（如 Prettier）的集成策略

当项目中引入 Prettier 进行统一格式化时，可能会与 DevEco Studio 内置格式化器产生冲突。建议采用以下方案之一：

• 方案一：完全使用 Prettier，关闭 IDE 的自动格式化，通过 husky + lint-staged 在 Git 提交前格式化。
• 方案二：在 DevEco Studio 中安装 Prettier 插件，并设置其为默认格式化工具。
• 方案三：配置 Prettier 忽略特定规则，使其与 ArkTS 默认风格兼容。

示例：.prettierrc 配置文件内容：

{
  "semi": false,
  "singleQuote": true,
  "tabWidth": 4,
  "trailingComma": "es5",
  "printWidth": 80
}

6. 自动化流程图：保存时格式化决策路径

graph TD
            A[用户保存文件] --> B{是否启用 Actions on Save?}
            B -- 否 --> C[仅保存，不格式化]
            B -- 是 --> D[触发 Reformat Code 动作]
            D --> E{是否存在 Prettier 配置?}
            E -- 是 --> F[调用 Prettier 格式化]
            E -- 否 --> G[调用内置 ArkTS 格式化器]
            F --> H[格式化完成并保存]
            G --> H
            H --> I[文件保存成功]

7. 高级配置建议：团队协作与 CI/CD 集成

对于大型团队，建议将代码风格标准化纳入工程规范。可通过以下方式实现一致性：

• 在项目仓库中提供 code-style.xml 导出配置，供团队成员导入。
• 使用 eslint-plugin-harmony 进行静态检查，配合 prettier 实现格式统一。
• 在 CI 流程中添加格式化校验步骤，防止不合规代码合入主干。
• 利用 DevEco Studio 的 File Watchers 插件，监听 .ets 文件变化并自动格式化。

CI 脚本示例（GitHub Actions）：

name: Format Check
on: [push, pull_request]
jobs:
  format:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Setup Node.js
        uses: actions/setup-node@v3
        with:
          node-version: '16'
      - run: npm install
      - run: npx prettier --check "src/**/*.ets"