Don't require Docs for short methods in require-jsdoc

[nrauschcom]

Motivation

Using the require-jsdoc rule, we currently have no way of excluding "trivial" methods, so we have to write many comments that just paraphrase the method name. In Java-Checkstyle, we have the option of excluding methods with less than n rows, where n can be specified with the parameter minLineCount (https://checkstyle.sourceforge.io/apidocs/com/puppycrawl/tools/checkstyle/checks/javadoc/MissingJavadocMethodCheck.html).

We already have similar options for get/set accessors and we can exclude specific things like constructors using the context property, but especially for projects using method getters/setters instead of JavaScript accessors, I think such a parameter would improve the usability of the rule. My projects are not using accessors because I believe it is an antipattern (https://www.reddit.com/r/typescript/comments/87t1h7/are_getters_and_setters_an_antipattern/) but I would really like to enforce comments for more complex methods.

Current behavior

Currently, we would have to write parapharasing comments to our getters/setters in a project:

/**
 * Returns the ID of this object.
**/
getId(): number {
  return this.id;
}

/**
 * Sets the ID of this object.
 * @param newId the new ID of this object
**/
setId(newId: number): void {
  this.id = id;
}

Desired behavior

I would like to set a property like "minLineCount": 2 in my .eslintrc.json to suppress warings for one-liner methods. This would result in the code above not needing comments, and we would not have to write the same thing in three rows:

getId(): number {
  return this.id;
}

setId(newId: number): void {
  this.id = id;
}

Alternatives considered

Currently we have the option of disabling the rule for get and set accessors, so we could consider implementing a "detection" mechanism for plain getter and setter methods (e.g. should be simple using a regular expression). However, since people are already using minLineCount in a Java/CheckStyle context, I think that one would be the easier-to-implement and more convenient option.

[brettz9]

I submitted #871 to handle this. I allowed for both a global minLineCount and a context-specific one (since one might want different lengths for variables, functions, etc.). Note that we count the whole length of the node, e.g, 3 lines for your methods (a method technically could be just a () { /* one line */ }).

[nrauschcom]

@brettz9 you rock! thanks for implementing this so fast.
In my case, implementing methods in a single line is not allowed anyway, so this solution perfectly fits my use-case.
Hope the other maintainers find this useful as well.

[gajus]

🎉 This issue has been resolved in version 39.2.0 🎉

The release is available on:

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

Your semantic-release bot 📦🚀