【鸿蒙开发实战篇】鸿蒙开发中如何利用代码检查工具（codelinter）的技巧和经验

大家好，我是 V 哥。 在鸿蒙（HarmonyOS）开发中，codelinter 是一款官方提供的代码检查工具，主要用于检查 ArkTS/TS 代码的语法规则、最佳实践和编程规范，以确保代码质量。

联系V哥获取 鸿蒙学习资料

以下是 codelinter 工具的详细使用方法和步骤：

一、 使用场景

codelinter 工具支持两种主流的使用方式，适用于不同的业务场景：

1. 在 IDE 中快速检查与修复

   • 适用场景 ：在日常开发过程中，快速对单个或多个文件进行代码质量检查，并能立即查看问题和进行修复。
   • 操作方法 ：在 DevEco Studio 编辑器窗口中，右键点击想要检查的文件或目录，然后选择 Code Linter 即可开始检查。

2. 通过命令行进行自动化检查

   • 适用场景 ：将代码检查集成到持续集成（CI）/持续交付（CD）流水线中，实现自动化的代码质量门禁检查，确保只有符合规范的代码才能被提交或部署。
   • 操作方法 ：通过命令行工具调用 codelinter 对整个工程进行检查，并可以生成报告。

二、 详细使用步骤

我们将重点介绍更具复用性和自动化价值的 命令行工具 的使用方法。

第一步：获取并配置命令行工具

1. 下载工具 ：从华为开发者官网的 CommandLine 工具包中获取 codelinter 命令行工具。
2. 解压与环境变量配置 ：将下载的工具包解压，并将其 bin 目录添加到系统的环境变量中，以便在任意位置使用 codelinter 命令。

第二步：配置检查规则（可选但推荐）

为了让代码检查更贴合团队的编码规范，您可以在工程根目录下创建一个名为 code-linter.json5 的配置文件。

• 核心配置项说明 ：
  • files 和 ignore：用来指定需要检查的文件范围。

        {
          "files": [" **/*.ets", "** /*.ts"], // 需要检查的文件类型
          "ignore": ["build/ **/*"]         // 忽略检查的目录
        }

*   `ruleSet` 和 `rules`：用来配置启用哪些规则集以及对具体规则进行个性化设置。

        {
          "ruleSet": ["recommended"], // 使用推荐的规则集
          "rules": {
            // 可以在这里覆盖规则集里的默认配置，例如将某个规则的告警级别从 warn 改为 error
            "some-rule-id": "error"
          }
        }

** 第三步：执行代码检查 **

配置完成后，您就可以在工程目录下运行 codelinter 命令了。

基础语法：

    codelinter [options] [dir]

*   `dir`：指定要检查的工程根目录，不指定则默认为当前目录。
*   `options`：一系列可选参数。

常用命令组合：

1.  检查指定工程，并使用特定配置文件：

        codelinter -c ./path/to/code-linter.json5 /your/project/dir

2.  检查当前目录，并自动修复可快速修复的问题：

        codelinter --fix

3.  检查指定工程，并将结果输出为 JSON 格式保存到文件：

        codelinter /your/project/dir --format json -o report.json

三、 实际案例演示

假设我们有一个简单的鸿蒙项目，其目录结构如下：

my-harmony-project/
├── src/
│   └── main/
│       ├── pages/
│       │   └── index.ets
│       └── utils/
│           └── helper.ts
└── build/
    └── ... (编译产物)

我们想对 src/main 目录下的所有 .ets 和 .ts 文件进行代码检查，但排除 build 目录。

操作步骤如下：

1. 创建配置文件： 在 my-harmony-project 根目录下创建 code-linter.json5 文件，并写入以下内容：

    {
      "files": ["src/main/** /*.ets", "src/main/ **/*.ts"],
      "ignore": ["build/** /*"],
      "ruleSet": ["recommended"]
    }

2. 执行检查命令 ： 在 my-harmony-project 根目录打开终端，执行以下命令：

    codelinter -c code-linter.json5 .

3. 查看检查结果 ： 命令执行后，终端会输出详细的检查报告，列出所有发现的问题及其位置和描述。您可以根据报告中的指引手动修改代码，或者再次运行命令加上 --fix 参数来自动修复部分问题。

通过以上步骤，您就可以系统化地在鸿蒙6开发中使用 codelinter 工具来保证代码质量了。