关于harmonyos:HarmonyOS代码Code-Linter检查

48次阅读

共计 3238 个字符,预计需要花费 9 分钟才能阅读完成。

Code Linter 代码查看

Code-Linter 针对 ArkTS/TS 代码进行最佳实际、编程标准方面的查看,目前还会查看 ArkTS 语法规定。开发者可依据扫描后果中告警提醒手工修复代码缺点,或者执行一键式主动修复,在代码开发阶段,确保代码品质。

查看办法:

在已关上的代码编辑器窗口单击右键点击 Code Linter,或在工程治理窗口中鼠标选中单个或多个工程文件 / 目录,右键抉择 Code Linter 执行代码查看。

配置代码查看规定

在工程根目录下创立 code-linter.json5 配置文件,可对于代码查看的范畴及对应失效的查看规定进行配置,其中 files 和 ignore 配置项独特确定了代码查看范畴,ruleSet 和 rules 配置项独特确定了失效的规定范畴。具体配置项性能如下:

files:配置待查看的文件名单,如未指定目录,规定实用于所有文件,例如:[“/.ets”,”/.js”,”*/.ts”];

ignore:配置无需查看的文件目录,其指定的目录或文件需应用相对路径格局,绝对于 code-linter.json5 所在工程根目录,例如:build/*/

ruleSet:配置查看应用的规定集,规定集反对一次导入多条规定;目前仅反对 all 和 recommended 两种规定集,规定详情请参见代码查看规定表。

rules:能够基于 ruleSet 配置的规定集,新增额定规定项,或批改 ruleSet 中规定默认配置,例如:将规定集中某条规定告警级别由 warn 改为 error。

overrides:针对工程根目录下局部特定目录或文件,可配置定制化查看的规定。

{
  "files":   // 用于示意配置实用的文件范畴的 glob 模式数组。在没有指定的状况下,利用默认配置
  [
    "**/*.ets",   // 字符串类型
    "**/*.js",
    "**/*.ts"
  ],
  "ignore":  // 一个示意配置对象不应实用的文件的 glob 模式数组。如果没有指定,配置对象将实用于所有由 files 匹配的文件
  [
    "build/**/*",    // 字符串类型
    "node_modules/**/*"
  ],
  "ruleSet":       // 设置查看待利用的规定集, 以后仅反对 IDE 内置规定集 all、recommended
  ["plugin:@typescript-eslint/recommended"    // 快捷批量引入的规定集, 枚举类型:plugin:@typescript-eslint/all, plugin:@typescript-eslint/recommended],
  "rules":         // 能够对 ruleSet 配置的规定集中特定的某些规定进行批改、去使能, 或者新增规定集以外的规定;ruleSet 和 rules 独特确定了代码查看所利用的规定
  {
    "@typescript-eslint/no-explicit-any":  // ruleId 前面跟数组时, 第一个元素为告警级别, 前面的对象元素为规定特定开关配置
    [
      "error",              // 告警级别: 枚举类型, 反对配置为 error, warn, off
      {"ignoreRestArgs": true   // 规定特定的开关配置, 为可选项, 不同规定其上层的配置项不同}
    ],
    "@typescript-eslint/explicit-function-return-type": 2,   // ruleId 前面跟独自一个数字时, 示意仅设置告警级别, 枚举值为: 2(error), 1(warn), 0(off)
    "@typescript-eslint/no-unsafe-return": "warn"            // ruleId 前面跟独自一个字符串时, 示意仅设置告警级别, 枚举值为: error, warn, off
  },
  "overrides":      // 针对特定的目录或文件采纳定制化的规定配置
  [
    {
      "files":   // 指定须要定制化配置规定的文件或目录
      ["entry/**/*.ts"   // 字符串类型],
      "excluded":
      ["entry/**/*.test.js" // 指定须要排除的目录或文件, 被排除的目录或文件不会被查看; 字符串类型],
      "rules":   // 反对对 overrides 外公共配置的规定进行批改、去使能, 或者新增公共配置以外的规定; 该配置将笼罩公共配置
      {
        "@typescript-eslint/explicit-function-return-type":  // ruleId: 枚举类型
        [
          "warn",     // 告警级别: 枚举类型, 反对配置为 error, warn, off; 笼罩公共配置, explicit-function-return-type 告警级别为 warn
          {allowExpressions: true    // 规定特定的开关配置, 为可选项, 不同规定其上层的配置项不同}
        ],
        "@typescript-eslint/no-unsafe-return": "off"   // 笼罩公共配置, 不查看 no-unsafe-return 规定
      }
    }
  ]
}

查看 / 解决代码查看后果

扫描实现后,在底部工具面板查看查看后果。双击某条告警后果,能够跳转到对应代码缺点地位;选中告警后果时,能够在右侧 Defect Description 窗口 查看告警对应的规定具体阐明,其中蕴含正向和反向示例,并依据其中的倡议批改代码。关上 修复模式 开关,查看可修复的代码规定,点击代码修复图标,能够一键式批量修复告警,并刷新查看后果。

屏蔽告警信息:

  • 在某些非凡场景下,若扫描后果中呈现误报,点击单条告警后果后的Ignore 图标,能够疏忽对告警所在行的 code
    linter 查看;或勾选多条待屏蔽的告警,点击工具面板右上角“屏蔽告警”图标批量执行;点击文件后的 Ignore 图标能够疏忽对整个文件的 code
    linter 查看;
  • 在文件顶部增加正文 / eslint-disable / 能够屏蔽整个文件执行 code linter 查看,在 eslint-disable
    后退出一个或多个以逗号分隔的规定 Id,能够屏蔽具体查看规定;
  • 在须要疏忽查看的代码块前后别离增加 / eslint-disable / 和 / eslint-enable/ 增加正文信息,再执行Code Linter,将不再显示该代码块扫描后果;在待屏蔽的代码行前一行增加 / eslint-disable-next-line /,也可屏蔽对该代码行的 codelinter 查看。

如需复原疏忽的报错信息,能够间接删除该行上方的正文,从新执行 Code Linter 查看。

导出查看后果:点击工具面板右上角导出按钮,即可导出查看后果到 excel 文件,蕴含告警所在行,告警明细,告警级别等信息。

为了可能让大家跟上互联网时代的技术迭代,在这里跟大家分享一下我本人近期学习心得以及参考网上材料整顿出的一份最新版的鸿蒙学习晋升材料 ,有须要的小伙伴自行支付, 限时开源,先到先得~~~~

支付以下高清学习路线原图请点击→《鸿蒙全套学习指南》纯血鸿蒙 HarmonyOS 根底技能学习路线图

支付以上残缺高清学习路线图,请点击→《鸿蒙 (Harmony OS)开发学习手册》小编本人整顿的局部学习材料(蕴含有高清视频、开发文档、电子书籍等)

以上分享的学习路线都适宜哪些人跟着学习?
- 应届生 / 计算机专业通过学习鸿蒙新兴技术,入行互联网,将来高起点待业。
- 0 根底转行提前布局新方向,抓住风口,自我晋升,取得更多就业机会。
- 技术晋升 / 进阶跳槽倒退瓶颈期,晋升职场竞争力,疾速把握鸿蒙技术,享受蓝海红利。

最初

鸿蒙开发学习是一个系统化的过程,从基础知识的学习到实战技能的锻炼 ,再到对前沿技术的摸索,每一环节都至关重要。 心愿这份教程材料能帮忙您疾速入门并在鸿蒙开发之路上步步攀升,成就一番事业。让咱们一起乘风破浪,拥抱鸿蒙生态的广大将来!

如果你感觉这篇内容对你有帮忙,我想麻烦大家动动小手给我:点赞,转发,有你们的『点赞和评论』,才是我发明的能源。

关注我,同时能够期待后续文章 ing,不定期分享原创常识。

想要获取更多残缺鸿蒙最新 VIP 学习材料,请点击→《鸿蒙根底入门学习指南》

正文完
 0