Allow a single empty line between jsdoc and codeblock

[henryruhs]

Hey,

I wonder why this plugin is not supporting a single empty line after the jsdoc:

/**
 * @return string
 */

function foo()
{
    return 'bar';
}

At the moment only docked jsdocs like this are detected:

/**
 * @return string
 */
function foo()
{
    return 'bar';
}

A similar TSLint rule named completed-docs for example is okay with that.

[brettz9]

Please clarify what you mean by not supporting a single empty line.

We have a rule, newline-after-description, that can disallow (or require) a single empty line if that is the style chosen, but it is not required.

Our "recommended" config sets this rule by default to require a newline. You can change its value to "never" to prevent newlines, or just disable the rule "jsdoc/newline-after-description": "off" if you wish to cancel the rule if inherited from elsewhere.

[henryruhs]

We are talking about different things - my question was not related to a newline after the description, it was related to a newline after the docblock / jsblock... I updated the example(s) in the original post!

A rule like that would be something like "jsdoc/newline-after-jsdoc": "on".

[brettz9]

Gotcha... On the main README, I've now added formal documentation for the preexisting maxLines and minLinessettings (usable in conjunction with all rules, and enforceable via the require-jsdoc rule). (They were in the example code previously but with no dedicated section to explain their usage.)

So if you set the maxLines to at least 2 (above the default of 1), you should be good (and if you want it never be less than one empty line, set the minLines to 2 (above the default of 0) as well).

[henryruhs]

This works for me, thank you 👍

"settings": {
	"jsdoc": {
		"maxLines": 2
	}
}

[gajus]

🎉 This issue has been resolved in version 20.4.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀