SwiftLint自定义规则中正则表达式匹配行号问题的解决方案

在SwiftLint项目中，开发者经常需要创建自定义规则来检查代码风格问题。本文重点讨论一个常见问题：当使用正则表达式定义自定义规则时，警告信息出现在错误行号上的情况。

问题现象

开发者创建了两个自定义规则来检查布尔值的冗余比较：

1. 检查== true的不必要比较
2. 检查== false的不必要比较

规则配置如下：

custom_rules:
  already_false:
    regex: '^(?:(?!\?).)* == false'
    message: "Don't compare to false, just use !value."
  already_true:
    regex: '^(?:(?!\?).)* == true'
    message: "Don't compare to true, just use the bool value."

虽然规则能够正确识别问题代码，但警告信息却出现在实际代码行上方几行的位置，给开发者带来了困扰。

问题根源

这个问题的根本原因在于SwiftLint处理正则表达式时的默认行为。SwiftLint在匹配正则表达式时默认启用了两个重要标志：

1. s标志（点号匹配换行符）
2. m标志（^和$匹配行的开始和结束）

这意味着：

• .会匹配包括换行符在内的任何字符
• ^和$会匹配每行的开始和结束，而不仅仅是整个字符串的开始和结束

在示例的正则表达式中，^(?:(?!\?).)*会贪婪地匹配尽可能多的行，直到遇到== true或== false。因此，匹配的起始位置可能远早于实际问题的位置。

解决方案

要解决这个问题，可以在正则表达式前添加(?-s)标志来禁用点号匹配换行符的特性：

custom_rules:
  already_false:
    regex: '(?-s)^(?:(?!\?).)* == false'
    message: "Don't compare to false, just use !value."
  already_true:
    regex: '(?-s)^(?:(?!\?).)* == true'
    message: "Don't compare to true, just use the bool value."

这样修改后，正则表达式中的.将不再匹配换行符，警告信息会准确地出现在包含== true或== false的那一行。

深入理解正则表达式标志

为了更好地理解这个问题，我们需要了解几个关键的正则表达式标志：

1. s标志（DOTALL模式）：

   • 默认情况下，.匹配除换行符外的任何字符
   • 启用s标志后，.也会匹配换行符

2. m标志（MULTILINE模式）：

   • 默认情况下，^和$只匹配整个字符串的开始和结束
   • 启用m标志后，^和$也会匹配每行的开始和结束

3. (?-s)语法：

   • 这是一种内联标志语法，可以在正则表达式内部修改标志设置
   • (?-s)表示禁用s标志

实际应用建议

在编写SwiftLint自定义规则的正则表达式时，建议：

1. 明确考虑是否需要跨行匹配
2. 如果不确定，可以先用(?-s)限制匹配范围
3. 测试规则时，特别注意警告信息的位置是否正确
4. 对于复杂的多行匹配，可能需要更精确地设计正则表达式

总结

SwiftLint的自定义规则功能非常强大，但正则表达式的匹配行为可能会带来一些意想不到的结果。通过理解SwiftLint默认的正则表达式标志设置，并合理使用内联标志语法，可以确保警告信息准确地出现在问题代码所在的行。记住(?-s)这个简单的解决方案，可以帮助你快速解决类似的行号不匹配问题。