Make Custom SwiftLint action regex ignore comments

Question

I have a custom SwiftLint action to flag up print() statements:

custom_rules:
    disable_print:
      included: ".*\\.swift"
      name: "print usage"
      regex: "((\\bprint)|(Swift\\.print))\\s*\\("
      message: "Don't use print"
      severity: error

It works but it also flags whenever I have a print() statement specified in a documentation comment like this:

/// some comment mentioning print("hello") <- Error here
func myFunc() {}

How can I alter the regex so it ignores the print statement whenever it's in a documentation comment?

Why do you flag print statements in the first place? Wouldn't it be easier to disable the rule for specific places in comments? — Sulthan, Mar 11 '22 at 18:42
@Sulthan Because I don't want them inside my swift package. I've no idea if that's easier or not — Tometoyou, Mar 11 '22 at 18:49

score 1 · Accepted Answer · answered Mar 11 '22 at 18:50

1

It seems that a custom rule can specify what type of code will match. The property is called match_kinds, example from Swiftlint Readme:

match_kinds: # SyntaxKinds to match. optional.
   - comment
   - identifier

Specifying identifier should be enough for your use case.

answered Mar 11 '22 at 18:50

Sulthan

128,090
22
218
270

"scanner: while scanning for the next token in line ..." – Hogdotmac Nov 11 '22 at 13:54

Make Custom SwiftLint action regex ignore comments

1 Answers1