no-inline-comments exception for istanbul ignore comments

[coreyfarrell]

What rule do you want to change?
no-inline-comments

Does this change cause the rule to produce more or fewer warnings?
Fewer

How will the change be implemented? (New option, new default behavior, etc.)?
Either a new option or default behavior could work depending on what eslint maintainers think is appropriate.

Please provide some example code that this change will affect:

if (condition1) {
  console.log('condition1');
} /* istanbul ignore else */ else if (condition2) {
  console.log('condition2');
} else {
  console.log('unreachable');
}

What does the rule currently do for this code?
Report an error

What will the rule do after it's changed?
Allow an exception for istanbul ignore comments. This is needed as the location of this comment matters. For it to ignore the chained else branch the comment needs to be directly before else if or between the else and if.

Are you willing to submit a pull request to implement this change?
I can try if this is an acceptable change and if I'm given guidance about an option vs default behavior.

[ilyavolodin]

Can you provide an error that you are seeing?

[coreyfarrell]

eslint output:

/usr/src/npm/tmp/test.js
  3:3  error  Unexpected comment inline with code  no-inline-comments

✖ 1 problem (1 error, 0 warnings)

[mdjermanovic]

An option where user can define a regex pattern (or array of patterns?) to ignore comments that match the pattern seems reasonable to me.

[kaicataldo]

I think an option to allow this would be fine. Alternatively, you can disable the no-inline-comments rule around these comments using eslint-disable comments.

[mdjermanovic]

I think it would be useful to support this in some way 👍

Exceptions (default and options) are already supported in other comment rules: line-comment-position, capitalized-comments and lines-around-comment.

no-inline-comments is very similar to line-comment-position (actually, it looks like they're overlapping/conflicting for line comments?).

[eslint-deprecated]

Unfortunately, it looks like there wasn't enough interest from the team
or community to implement this change. While we wish we'd be able to
accommodate everyone's requests, we do need to prioritize. We've found
that issues failing to reach accepted status after 21 days tend to
never be accepted, and as such, we close those issues.
This doesn't mean the idea isn't interesting or useful, just that it's
not something the team can commit to.

Thanks for contributing to ESLint and we appreciate your understanding.

[mdjermanovic]

I'll champion this.

[mdjermanovic]

This will be fixed by #13029, we'll add "ignorePattern" option (accepts string that will be treated as regex) which will allow users to configure this rule to ignore istanbul comments.