TODO warning message includes excess leading whitespace

[mattrubin]

With todo warnings enabled, this line

            // TODO: Scroll to the newly-expanded section

becomes this warning:

warning: Todo Violation: TODOs should be avoided             : Scroll to the n... (todo)

The TODO comment is indented to align with the code around it, but the custom message for the todo rule is generated by simply stripping the "TODO" and "//" strings from the line. The leading whitespace and the colon I use in my TODO comments are left in the message, which is then truncated to leave very few useful characters.

The leading whitespace should be removed to allow more room for content in the message. Instead of trying to extract the important subset of the text from the line, the rule could simply strip the "//" and the preceding characters and give this warning:

warning: Todo Violation: TODO: Scroll to the newly-expanded section (todo)

[wbagdon]

Resolved with #801

[norio-nomura]

confirmed that this issue has been resolved.

[msaveleva]

swiftlint 0.12.0 – still have this issue.

[wbagdon]

It's fixed in master.
Will be included in the next release.