Comparison with deprecated JSdoc related ESLint rules

ESLint has end-of-lifed their jsdoc support and are recommending eslint-plugin-jsdoc as a replacement: https://eslint.org/blog/2018/11/jsdoc-end-of-life

JSDoc features deprecated by ESLint

Deprecated JSDoc component	eslint-plugin-jsdoc replacement or tracking issue
"Maintaining the Doctrine JSDoc comment parser"	jsdoctypeparser
"The require-jsdoc rule"	#162
"The valid-jsdoc rule"	#107; see also tables below
"The SourceCode#getJSDocComment method"	#189 (not a replacement, but we must reimplement)

Equivalents for valid-jsdoc features

INCOMPLETE

Number	Feature from valid-jsdoc rule	Replacement within eslint-plugin-jsdoc or issue	Notes
1	"missing return tag: @return or @returns"	require-returns
2	"missing ... return type"	require-returns-type
3	"missing ... return description"	require-returns-description
4	"missing parameter tag: @arg, @argument, or @param"
5	"missing parameter ... type"
6	"missing parameter ... description"
7	"inconsistent order of parameter names in a comment compared to the function or method"
8	"syntax error"		We may need to examine source
9	Requiring return statement upon use of @return(s) tag	require-returns-check	Behavior only referenced in documentation code comment

The "correct" code comments for valid-jsdoc also mention some specific behavior pertaining to these features:

@returns:

• @constructor tag allows missing @returns tag (#1 above)
• class constructor allows missing @returns tag (#1 above)
• @override tag allows missing ... @returns tags (#1 above)
• @abstract tag allows @returns tag without return statement (#9 above)

@param tag:

• @override tag allows missing @param ... tags (#4 above)

Finally, this large rule had a number of options we ought to reimplement:

INCOMPLETE

Option	Accepted types	Replacement within eslint-plugin-jsdoc or tracking issue
"prefer"	object (item to replace keyed to replacement)
"preferType"	object (item to replace keyed to replacement)
"requireReturn"	boolean
"requireReturnType"	boolean
"matchDescription"	string (regular expression)
"requireParamDescription"	boolean
"requireReturnDescription"	boolean
"requireParamType"	boolean