Rule: no-trailing-spaces in comments

When trailing spaces are present in comments (illustrated as underscore):

/* eslint no-trailing-spaces: 1 */
// trailing space _

ESLint produces the same warning as for lines of code: Trailing spaces not allowed no-trailing-spaces

I believe this rule should be relaxed for comments, or at least there should be an option to configure this.

<bountysource-plugin>

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource. </bountysource-plugin>

[mik-jozef]

I’d also welcome this. Sometimes I do:

/**
 * A long comment with multiple paragraphs.
 *     <- empty line, trailing space
 * Blabla
 */
exports.myWonderfulMethod(needs, long, documentation) { ...

[pdehaan]

@nzakas Both, I guess… 🤷 I have worked on systems in the past that used Markdown flavored JSDocs. We weren’t using ESLint at the time and it was a custom Ruby-based doc system, IIRC.

I’d be happy with two separate rules, or maybe just an option on no-trailing-spaces for “ignore-comments” which defaults to true (which would match JSLint/JSHint behavior if I’m understanding @asapach’s https://github.com/eslint/eslint/issues/1229#issuecomment-55011448 correctly). If for some reason I wanted ESLint to tell me that my doc comments had trailing spaces, I could always pref it on using something like:

rules:
  no-trailing-spaces: [1, {ignore-comments: false}]

So I can think of places I probably wouldn’t want spaces in doc comments, as well as the use case above where trailing spaces are required (unless you want to manually throw in
tags into your JSDoc comments).

Or not, what do I know. (Spoiler alert: Nothing. I don’t know nothing.)