鸿蒙Next开发代码检查Code Linter使用介绍

Code Linter针对ArkTS/TS代码进行最佳实践/编程规范方面的检查。

检查方法：

编辑器自带Code Linter。

在已打开的代码编辑器窗口单击右键点击Code Linter，或在工程管理窗口中鼠标选中单个或多个工程文件/目录，右键选择Code Linter执行代码检查。

Code Linter命令行。

Code Linter同时支持使用命令行执行代码检查与修复，可将Code Linter工具集成到门禁或持续集成环境中。

获取：请在获取命令行工具下载CommandLine。

配置：命令行工具需要解压工具包，将bin目录配置到配置完环境变量才能使用。

场景一：配置规则增加删除

配置步骤：

在工程根目录下创建code-linter.json5配置文件，可对于代码检查的范围及对应生效的检查规则进行配置，ruleSet和rules配置项共同确定了生效的规则范围。

场景二：指定代码检查范围

如果只想检查test.ets文件：

配置步骤：通过配置"file"和"ignore"字段来指定需要检测的文件类型和忽略检测的文件。

说明：当前指定目录是以模块根路径为绝对路径指定，不支持绝对路径。

效果：codelinter根据通配符在每个模块下按**/test.ets匹配文件。

场景三：将codelinter集成到流水线

步骤：

按上述步骤配置完commandline tools工具。

在非工程根目录下使用命令行工具：

codelinter [dir] /*[dir]指定执行检查的工程根目录，*/
-c filepath [dir]/*指定执行检查的规则配置文件位置，*/
--fix // 对指定工程中的告警进行修复。保存指定代码检查结果，默认放在命令行工具文件夹result文件下。
codelinter -o filepath2 // filepath2为指定存放代码检查结果的文件路径。

如何触发：

在流水线构建命令前，插入上述执行脚本即可。

总结

codelinter检查的结果一般不会影响编译，用户不修改也没关系；codelinter检查的结果，用户可以选择不改，又或者不想检查出来，就可以/* eslint-disable */屏蔽，但只能屏蔽有Ignore图标的。若扫描结果中出现误报，单条告警结果后的有Ignore图标，可以屏蔽若检查规则后存在warning图标，表明此处存在ArkTS语法规范问题。