LineLength: add an IgnoreComments parameter

[chastell]

Sometimes comments contain lines that can’t be easily wrapped (like URLs). Currently, the only way to not trigger LineLength with such comments is to exclude the whole file.

I think it would make sense to add an IgnoreComments parameter to LineLength, so that such comments wouldn’t trigger the cop.

[jonas054]

In such cases I would use

# rubocop:disable LineLength
# section containing unbreakable long comments
# rubocop:enable LineLength

That would disable the cop in just the special part of the code that can't conform. Generally speaking, long comment lines are just as bad as long code lines, so I'd prefer leaving the checks enabled to the largest possible extent.

[chastell]

Ok, this makes sense. I’ll see how well the rest of the team likes this. ;)

[yujinakayama]

I agree to the “long comment lines are just as bad as long code lines”, but at the same time I think putting rubocop:disable LineLength for each long URL (such as URL of a commit on GitHub) is ugly and annoying. I think probably we can detect URLs and automatically allow them.

[bbatsov]

Maybe. I was thinking that such a problem exists in the code as well:

URL = 'http://veeeerrryyyyyyy.looooooooooooong-boooooooooooring-naaaaaaaaaaaaame.com'

[jdickey]

Good argument for URL shorteners. We've been using Bit.ly, coupled with explanatory comments, when we run into things like that. Yes, shorteners kill semantics and bring in an outside dependency, but does anyone have any better ideas? We'd experimented with a UrlRegistry class that basically just wrapped a Hash of "meaningful" short symbolic names associated with URL-as-string values; that seems almost as bad, complicating reuse across projects...