Update: Allow JSX exception in no-inline-comments (fixes #11270)

[mdjermanovic]

What is the purpose of this pull request? (put an "X" next to item)

[X] Changes an existing rule #11270

Marked as 'Update' although this change produces fewer warnings by default, because it wasn't a bug.

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.)?

new default behavior

Please provide some example code that this change will affect:

/*eslint no-inline-comments: "error"*/

var foo = (
    <div>
      {/* These braces are just for this comment and there is nothing else on this line */}
      <h1>Some heading</h1>
    </div>
)

var quux = (
    <div>
      {/*
        Multiline
        comment
      */}
      <h1>Some heading</h1>
    </div>
)

What does the rule currently do for this code?

2 errors.

What will the rule do after it's changed?

No errors.

What changes did you make? (Give an overview)

Allow a comment in JSX to be on the same line as the braces (or one brace), only if it there is nothing else on the same line and the braces are for comment only (this generates JSXEmptyExpression node).

Is there anything you'd like reviewers to focus on?

These are currently errors, and will stay errors:

/*eslint no-inline-comments: "error"*/

var foo = <div>{ /* On the same line with other code */ }<h1>Some heading</h1></div>;

var bar = (
    <div>
    {   // These braces are not just for the comment, so it can't be on the same line
        baz
    }
    </div>
);

This was already allowed, and will stay allowed:

var bar = (
    <div>
    {
        // There is nothing else on this line
        baz
    }
    </div>
);

Also, two comments on the same line are currently an error everywhere (not just in JSX). This behavior is unchanged.

Labeling as evaluating, as I think it isn't decided yet is this a new default behavior or an option.

I 👍 for new default behavior.

[kaicataldo]

Left a thumb, but realized it would be clearer to leave a comment. I think making this the default behavior makes sense, especially since it leads to fewer errors being reported.

[platinumazure]

I agree that making this the default behavior makes more sense.

[kaicataldo]

LGTM, thanks!