Introduce " - " delimiter to allow rules to be commented

[kevinrandrup]

Introduce "-" delimiter to allow rules to be commented

Ex. swiftlint:disable:next force_try - Explanation here

[kevinrandrup]

I opened this PR as a result of #2623. Currently figuring out how Github forks work with rebasing. Rebased

[SwiftLintBot]

	12 Messages
📖	Linting Aerial with this PR took 3.16s vs 3.16s on master (0% slower)
📖	Linting Alamofire with this PR took 5.05s vs 4.99s on master (1% slower)
📖	Linting Firefox with this PR took 14.95s vs 14.9s on master (0% slower)
📖	Linting Kickstarter with this PR took 26.83s vs 26.81s on master (0% slower)
📖	Linting Moya with this PR took 2.45s vs 2.26s on master (8% slower)
📖	Linting Nimble with this PR took 2.21s vs 2.23s on master (0% faster)
📖	Linting Quick with this PR took 0.79s vs 0.81s on master (2% faster)
📖	Linting Realm with this PR took 3.72s vs 3.7s on master (0% slower)
📖	Linting SourceKitten with this PR took 1.48s vs 1.49s on master (0% faster)
📖	Linting Sourcery with this PR took 4.9s vs 4.91s on master (0% faster)
📖	Linting Swift with this PR took 38.24s vs 37.88s on master (0% slower)
📖	Linting WordPress with this PR took 29.18s vs 29.25s on master (0% faster)

Generated by 🚫 Danger

[kevinrandrup]

Question for whoever will review this PR: where do documentation changes need to be made?

The only place I've potentially found is SuperfluousDisableCommandRule.description

[kevinrandrup]

Is there anything I can do to move this PR forward?

[jpsim]

Thanks for the PR, @kevinrandrup, this is a pretty useful feature!

I know the suggested syntax is currently triggering a superfluous disable command warning, but that seems accidental more than related to the feature at all.

So I wouldn't do anything with SuperfluousDisableCommandRule at all, like adding the delimiter.

I'd rather see that added to the Command struct, ideally even parsing the text after the delimiter, perhaps as a trailingComment property of the command.

What do you think?

[kevinrandrup]

@jpsim Thanks for the feedback. I've updated the PR to parse extra text as Command.trailingComment. I still need to update a unit tests to verify that property but the parsing works. Updated.

[kevinrandrup]

@jpsim Anything else you need me to do?

[jpsim]

Nothing further to do, changes look good. Thanks @kevinrandrup!