【问题标题】:SwiftLint - allow one line guardsSwiftLint - 允许一名线卫
【发布时间】:2020-09-01 02:32:54
【问题描述】:

SwiftLint - 如何允许这样的单行保护条件:

guard let x = true else { return false }

并为其他情况保留conditional_returns_on_newline 功能?

编辑:

据我所知,SwiftLint 定义了违规规则,因此我必须编写正则表达式来扫描行以搜索:

if[...]{[...]}

请注意以下情况:

if array1.sorted(by: { $0 > $1 }).first! > 0, array2.isEmpty { x = 1 }

【问题讨论】:

  • 您可以编写自己的正则表达式规则。
  • 当然可以,但是如何构造规则来处理所有其他条件情况?
  • 你可以看到他们的规则是什么,所以如果你不喜欢它,你就改变它。但这是您的目标,您必须编写自定义正则表达式。

标签: ios swift xcode swiftlint


【解决方案1】:

有两种方法可以实现。

  1. 您可以禁用conditional_returns_on_newline 规则。您可以通过更新保存在项目代码文件夹中的规则文件在代码块级别、源文件级别或项目级别禁用它。这样做会禁用每个此类语句的规则(取决于禁用范围),例如 if true { return } 或 if true { return "YES" } else { return "NO" } 等。Here is the explanation 我认为您不想这样做。

  2. 第二个是编写自己的正则表达式规则。您可以在配置中定义基于正则表达式的自定义规则here is the detail explaination

编辑

第 2 点的高级实现,请按照以下步骤操作。

  1. 在项目级别打开.swiftlint.yml 并禁用给定规则conditional_returns_on_newline。
  2. 编写您自己的自定义规则,该规则将仅验证新行上的每个条件返回,除了单行保护返回。
  3. 添加自定义规则(我命名为 ks_conditional_returns_on_newline) 到您的 .swiftlint.yml 文件中, 您可以决定rule name、message、severity 和 included 等参数根据您的需要。

示例

custom_rules:
  ks_conditional_returns_on_newline:
    included: ".*\\.swift"
    name: "Custom Conditional Returns On New Line"
    regex: "(if)[^\n]*return"
    message: "Hey look at the the conditional returns on newline for if else"
    severity: error

我已经用 Xcode 验证了规则正则表达式,它运行良好。不过,我还没有验证将其添加到.swiftlint.yml。但我希望它会奏效。

【讨论】:

  • 在我的情况下只有第 2 点是可以接受的,但是如何构造它来处理所有其他条件情况?
  • @Kaktusiarz 谢谢,我明白了。高级实现,首先,我将禁用conditional_returns_on_newline 规则。我将编写一个新的自定义规则custom_conditional_returns_on_newline,其中将验证if、else 除守卫之外的换行符条件返回。我将不得不相应地形成一个正则表达式。完成正则表达式形成后,我将更新我的答案。
  • @Kaktusiarz 同时,你可以从这个github.com/realm/SwiftLint/issues/2988得到一个想法
  • @Kaktushiarz 检查您可以形成正则表达式的编辑并相应地定义自定义规则。
  • 感谢您的回答,但不幸的是,这并不容易。请查看我更新的问题。
【解决方案2】:

默认情况下,SwifLint 规则 conditional_returns_on_newline 处于禁用状态。所以,

  1. 首先启用conditional_returns_on_newline规则。
  2. 将if_only 设置为true

无需编写任何自定义规则

.swiftlint.yml 配置:

opt_in_rules: # some rules are only opt-in
    - conditional_returns_on_newline

conditional_returns_on_newline:
    if_only: true  

这里是规则链接:

https://realm.github.io/SwiftLint/conditional_returns_on_newline.html

【讨论】:

    【解决方案3】:

    我想我能够找到一个满意的解决方案:

    1. 禁用内置规则 - conditional_returns_on_newline。
    2. 为条件定义新的自定义规则:
    custom_rules:
      custom_conditional_returns_on_newline:
        name: "Conditional returns on new line"
        regex: '^[\h]*(if|else|while)[^\n]*\}$'
        message: "If/else and while constructions should not be defined in one line"
        severity: warning
    
    1. 将custom_rules 添加到whitelist_rules。

    【讨论】:

      猜你喜欢
      • 2019-06-06
      • 2017-01-15
      • 1970-01-01
      • 1970-01-01
      • 2021-01-29
      • 2023-01-16
      • 2018-04-02
      • 2019-11-18
      • 1970-01-01
      相关资源
      最近更新 更多