jsdoc/require-jsdoc: False positive when documentation is inherited from interface

[iliubinskii]

Expected behavior

Method without documentation should pass when there is a documentation for it in an interface located in "implements" section.

I have checked that this situation is correctly handled by typedoc (https://www.npmjs.com/package/typedoc) and vscode editor.
Both extract documentation from interface.

See that vscode undestands this situation:

Actual behavior

The rule shows error in the situation described above.

ESLint Config

const contexts = [
  ":not(BlockStatement) > FunctionDeclaration",
  "MethodDefinition",
  "TSMethodSignature",
  "TSPropertySignature > TSTypeAnnotation > TSFunctionType"
];

module.exports = {
  rules: {
    "jsdoc/require-jsdoc": [
      "warn",
      {
        checkConstructors: true,
        checkGetters: true,
        checkSetters: true,
        contexts,
        require: {
          ArrowFunctionExpression: false,
          ClassDeclaration: false,
          ClassExpression: false,
          FunctionDeclaration: false,
          FunctionExpression: false,
          MethodDefinition: false
        }
      }
    ]
  }
};

ESLint sample

export interface A {
  /**
   * Documentation.
   */
  f(): void;
}

export class B implements A {
  public f(): void {
    //
  }
}

new B().f();

Environment

    "node": ">=14.0.0",
    "eslint": "^7.30.0",
    "eslint-plugin-jsdoc": "^35.4.3",

---

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

[brettz9]

ESLint is not aware of the whole program, so if we were to support this, it would probably only check the current file. However, this is not something I'm really inclined to spend time on. PR would be fine.

[DerZyklop]

My workaround is usually to add a @see like

export class B implements A {
  /** @see A.f */
  public f(): void {

It works well with require-jsdoc and on hover over the f in B.f(…) you get the correct docs in the editor.

---

The only downside is that it does not play well with require-param, because require-param does not know the content of A.f (and probably never will).

[brettz9]

My workaround is usually to add a @see like

export class B implements A {
  /** @see A.f */
  public f(): void {

It works well with require-jsdoc and on hover over the f in B.f(…) you get the correct docs in the editor.

The only downside is that it does not play well with require-param, because require-param does not know the content of A.f (and probably never will).

You can use the option exemptedBy: ['see']

[github-actions]

🎉 This issue has been resolved in version 51.1.1 🎉

The release is available on:

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

Your semantic-release bot 📦🚀