You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It would be great to have a way of enforcing single line JSDoc comments, if the description is a single line, there are no non-inline JSDoc tags, and the last */ characters would fit within a (configurable?) line length of 80 characters, taking into account the current indentation of the comment.
/** * Multiline description: * * - Bullet A. * - Bullet B. */constfoo=true;
/** * [A super long single line description](https://example.example/asdf/asdf/as). */constfoo=true;
constfoo={a: {a: {a: {a: {a: {a: {a: {a: {a: {a: {a: {a: {a: {a: {a: {a: {a: {a: {a: {/** * Some description that is this long. */a: {},},},},},},},},},},},},},},},},},},},},};
Motivation
I regularly review PR's that have many multiline JSDoc comments containing only tiny single line descriptions. They are very verbose and vertically space inefficient; I would like an automated way to ensure such modules have more compact single line JSDoc comments resulting in a smaller module line count.
Current behavior
At first I hoped this would get the desired result:
I was to about to create a new related issue, but ill jump onto this instead. I would love a similar rule that is fixable. The rule should one-line the jsdoc if the compacted oneliner is below a given rule treshhold line length, the default could be 80 or 120. My motivation is less boilerplated code lines.
Not allowed
/** * @param {object} data */staticcoolMethod(data){}
Allowed (fixable)
/** @param {object} data */staticcoolMethod(data){}
It would be great to have a way of enforcing single line JSDoc comments, if the description is a single line, there are no non-inline JSDoc tags, and the last
*/
characters would fit within a (configurable?) line length of 80 characters, taking into account the current indentation of the comment.These would be errors:
These would not be errors:
Motivation
I regularly review PR's that have many multiline JSDoc comments containing only tiny single line descriptions. They are very verbose and vertically space inefficient; I would like an automated way to ensure such modules have more compact single line JSDoc comments resulting in a smaller module line count.
Current behavior
At first I hoped this would get the desired result:
But it seems that
minimumLengthForMultiline
just counts the length of the description, and doesn't account for the indentation of the comment, etc.Desired behavior
I would like a new
jsdoc/multiline-blocks
config option, to enforce the behavior explained above.Alternatives considered
N/A.
The text was updated successfully, but these errors were encountered: