jsdoc/require-jsdoc - publicOnly not working with contexts[].PropertyDefinition

[reececomo]

tl;dr: Trying to configure a rule so that we document all public members/properties/accessors.

Expected behavior

When using jsdoc/require-jsdoc I would expect publicOnly and contexts[].PropertyDefinition together to mean that public properties required docs.

Actual behavior

Private/protected members are also failing the lint check too (unexpectedly).

We tried ClassProperty too, but that appears to cause a lot of false negatives.

For context there are also these related tickets, but we did not find the answer:

• Typescript contexts in require-jsdoc #640
• ClassProperty context not working if publicOnly set to true #786
• Property context isn't working #841

ESLint Config

    "jsdoc/require-jsdoc": [
      'error',
      {
        checkConstructors: false,
        publicOnly: true,
        contexts: [
          'PropertyDefinition'
        ]
      }
    ],

ESLint sample

export class MyClass {

  public myPublicProperty: number = 1;
       /* ^ Missing JSDoc comment. eslint(jsdoc/require-jsdoc) - expected ✅ */

  private myPrivateProp: number = -1;
       /* ^ Missing JSDoc comment. eslint(jsdoc/require-jsdoc) - unexpected ❌ */

  // ...
}

Environment

• Node version: ^16.16.0
• ESLint version: 8.43.0
• eslint-plugin-jsdoc version: 46.4.0

[github-actions]

🎉 This issue has been resolved in version 46.4.1 🎉

The release is available on:

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

Your semantic-release bot 📦🚀

[reececomo]

@brettz9 same thing with require.MethodDefinition and the other requires 😬

Should I open a separate issue?

[reececomo]

Also, thanks for jumping on that so quickly!

[brettz9]

I need a code sample regardless of where you post it.

[reececomo]

It's the exact same issue but for class methods instead of properties

[brettz9]

So your context is exactly MethodDefinition?

[reececomo]

Moved to #1124 😄