Support comments when removing spaces between chained functions

[mannylopez]

Updating the blankLinesBetweenChainedFunctions rule to take comments into account when removing blank lines between chained functions.

So this:

[0, 1, 2]
    .map { $0 * 2 }

    // Multiplies by 3
    .map { $0 * 3 }

Will turn into:

[0, 1, 2]
    .map { $0 * 2 }
    // Multiplies by 3
    .map { $0 * 3 }

cc @calda

[calda]

Maybe this name could be improved, since this next token isn't always a comment. This could also be a good place to mention why we're doing this:

Suggested change

	let commentIndex = formatter.index(of: .nonSpaceOrLinebreak, after: endOfLine)
	{
	let startOfLine = formatter.startOfLine(at: commentIndex)
	// Make sure to preserve any code comment between the two lines
	let nextTokenOrComment = formatter.index(of: .nonSpaceOrLinebreak, after: endOfLine)
	{
	let startOfLine = formatter.startOfLine(at: nextTokenOrComment)

[mannylopez]

Added!

[calda]

Thanks!

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.23%. Comparing base (b0d492f) to head (e8d8656).

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #1723      +/-   ##
===========================================
+ Coverage    95.19%   95.23%   +0.03%     
===========================================
  Files           20       20              
  Lines        23248    23250       +2     
===========================================
+ Hits         22131    22141      +10     
+ Misses        1117     1109       -8     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[nicklockwood]

This looks good, thanks! I'm wondering if this should be put behind some sort of option though, in case there are scenarios where a developer deliberately wanted to leave a blank line above commented methods in the chain but remove them otherwise?