Eslint-plugin-jsdoc: Expected JSDoc block to be aligned. jsdoc/check-alignment

[OmgImAlexis]

The first returns a warning. The second is what was returned from --fix. The example I'm using is from the examples on jsdoc/check-alignment.

  ⚠  8:0  Expected JSDoc block to be aligned.  jsdoc/check-alignment

  1 warning

module.exports = function (si) {
    /**
      * Desc
      *
      * @param {number} foo
      */
     function quux(foo) {
     }
};

module.exports = function(si) {
    /**
  * Desc
  *
  * @param {number} foo
  */
    function quux(foo) {
    }
};

[golopot]

Looks like the rule does not handle tab indents properly.

[brettz9]

Fixed by #412

Note, however, that the fix is (including the approach before the recent fix) based on the assumption that the initial line is the one with the correct indentation. So in your case, the fixed code will look like:

module.exports = function (si) {
    /**
     * Desc
     *
     * @param {number} foo
     */
     function quux(foo) {
     }
};

If you wanted to see the indent instead made relative to the function or other context it is preceding, a new issue could be filed.

[OmgImAlexis]

@brettz9 a new issue would be a great idea. Would you mind opening it?

[brettz9]

I have filed #413 . In the future, please file yourself so you can be automatically subscribed to the issues and can state the concern as you see it.

To subscribe to that issue without needing to add any comments, you can click Github's "Subscribe" button on the page for #413 on the right-hand side of the page.

Thanks for the report!

[OmgImAlexis]

You don’t need to treat me like an idiot. I know how to use Github. I was on my phone when I saw the notification that’s all. 💁‍♀️

[brettz9]

I didn't know about the Subscribe button last year or so despite being on Github for years! But then again, I may be idiot, so I wouldn't know how to treat others otherwise. :)

[brettz9]

And FWIW, as a former teacher, I tend to overexplain things to everyone in the event not only that the immediate listener doesn't happen to know but also in case others coming across the issue don't either, so even if I do state something seemingly obvious, please don't take it as being directed at you.