[require-jsdoc] Question: Is it possible to not require jsdoc if the interface or abstraction already provide jsdoc?

[Shinigami92]

Motivation

Current behavior

I currently have setup following rule:

    'jsdoc/require-jsdoc': [
      'warn',
      {
        contexts: [
          'ClassDeclaration',
          'ClassProperty:not([accessibility=/(private|protected)/])',
          'ExportNamedDeclaration:has(VariableDeclaration)',
          'FunctionExpression',
          'MethodDefinition:not([accessibility=/(private|protected)/]) > FunctionExpression',
          'TSEnumDeclaration',
          'TSInterfaceDeclaration',
          'TSMethodSignature',
          // 'TSPropertySignature',
          'TSTypeAliasDeclaration'
        ]
      }
    ]

Sadly I don't see an option to prevent the need of writing jsdoc if the implemented interface or abstract class already provides JSDoc.
And I don't want to duplicate the JSDoc everywhere.

Desired behavior

Any kind of possibility to not warn when the function that is implemented already provides jsdoc, without the need of eslint-disable-next-line

[brettz9]

ESLint does not really provide tools for following around variables throughout a program. You might see if https://www.npmjs.com/package/@typescript-eslint/eslint-plugin or maybe the https://tsdoc.org/ folks were interested in implementing such a rule.

While this wouldn't prevent the need for adding a jsdoc block, the closest behavior we support would be that if you did add:

/**
 * @implements {...}
 */

...various other rules like require-param or require-returns will avoid reporting on that block (unless you explicitly set {settings: {jsdoc: {overrideReplacesDocs: false}}}).

But that is more of a generic jsdoc-based solution, not a fully TypeScript-aware one and does require the minimal block.

[Shinigami92]

You introduced me to the use of /** @inheritdoc */ 🎉
This is at least an option for me ❤️

I need to add it to many places but I think that's okay and also tells other devs in my team that it is intended

---

Maybe TS can be feed with an esquery override property when microsoft/TypeScript#39669 is released 🤔

---

You can close this issue if you like, or keep track with it and someday it can be implemented as a really nice improvement

[brettz9]

Sorry, but I think I should close this simply because I don't think there is any easy way for such tracing to be done with ESLint which does not trace or provide facilities to trace an entire interconnected program as TypeScript (or semmle) may do. If it becomes possible, we can reopen at such time.