Tslint: completed-docs should have an option to check every method/function overload

[captain-yossarian]

Feature request for completed-docs rule

Is it possible to enforce (add option if does not exist) jsDoc comment for function/method overloading?

[JoshuaKGoldberg]

@SerhiiBilyk sorry, what do you mean by "overloading"? Could you post a code snippet or two?

[captain-yossarian]

@JoshuaKGoldberg

class Foo {

    /*
     * Enforce jsDoc comment here
     */
    emit(event: string, data: number) => void;

    /*
     * Enforce jsDoc comment  here
     */
    emit(event:string, data: string) => void;

    emit(event:string, data:any) {
        // ....... some code
    }
}

[adidahiya]

this is not currently possible but seems like a reasonable request. currently TSLint will report 3 failures here but adding a jsdoc comment to any overload will make them go away:

  class Foo {
      emit(event: string, data: number): void;
-     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [Documentation must exist for methods.]
      emit(event: string, data: string): void;
-     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [Documentation must exist for methods.]
      emit(event: string, data: string | number) {
-     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [Documentation must exist for methods.]
          // ....... some code
      }
  }

[0815fox]

Did you do something on this? Because since my update from 5.12.x to 5.13.0 today, i get new reports for exactly that and I definitly do not want to write a separate comment for each overload ;-) If so: is there a not yet documented option to turn this back to "one documentation for all overloads required"?

[adidahiya]

hmm, that could have happened as a result of #3557. @JoshuaKGoldberg could you take a look?

[JoshuaKGoldberg]

Yes, the behavior is now to require one on all overloads.

{
  "rules": {
    "completed-docs": [
      true,
      {
        "methods": true
      }
    ]
  }
}

class Foo {
    // completed-docs: Documentation must exist for methods
    emit(event: string, data: number): void;

    // completed-docs: Documentation must exist for methods
    emit(event:string, data: string): void;

    /**
     * Exists in one place
     */
    emit(event:string, data:any) {
        // ....... some code
    }
}

I'll look at making this an opt-in behavior...

[0815fox]

Thumbs up for configurable. Suggestion:

"overloads": false