spaced-comment should allow line ending after markers

[tiansh]

What rule do you want to change?
spaced-comment

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

Please provide some example code that this change will affect:

/* eslint spaced-comment: ["error", "always", { "line": { "markers": ["/", "#region", "#endregion"] } }] */
/* eslint no-trailing-spaces: ["error"] */

//#region blah
const answer = 42;
//#endregion

console.log(answer);

What does the rule currently do for this code?

6:1 error Expected space or tab after '//#endregion' in comment spaced-comment

using --fix cannot fix it (since there are no possible auto fix)

What will the rule do after it's changed?

pass without tip an error

Are you willing to submit a pull request to implement this change?

Maybe no

---

spaced-comment does allow line ending after // without using markers. And this behavior should be applied to markers too imo.

[platinumazure]

Hi @tiansh, thanks for the issue.

This feels like a bug to me. I think it shouldn't matter if a comment has markers after the content or not.

I'm going to relabel this as a bug, but team members can feel free to correct that if needed.

[platinumazure]

Reproduction here, so marking as accepted.

[g-plane]

@platinumazure Repro link is broken.

[platinumazure]

@g-plane Sorry, bad paste. It's fixed now.

[mdjermanovic]

I'm working on this, but have a question. Should the rule also allow these:

/* eslint spaced-comment: ["error", "always", { "block": { "markers": ["foo"] } }] */

/*foo*/

/* eslint spaced-comment: ["error", "always", { "block": { "markers": ["foo"], balanced: true } }] */

/*foo*/

I.e. ignore a comment that contains only a marker like it already ignores an empty /**/

The issue with //#endregion is that the rule requires a \s after the marker, but there is nothing. Linebreak is not included in comment's value.

// immediately followed by the line ending is allowed simply because it's an empty comment.

[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 accepted issues failing to be implemented after 90 days tend to
never be implemented, 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.

[DmytroLapshyn]

If anyone cares for a workaround, this worked for me:

"markers": ["#region"],
"exceptions": ["#endregion"]