We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Split from #1122.
When using jsdoc/require-jsdoc I would expect publicOnly and require.MethodDefinition together to mean that public methods required docs.
jsdoc/require-jsdoc
publicOnly
require.MethodDefinition
Private/protected methods are also failing the lint check too (unexpectedly).
I imagine this issue unexpectedly would apply to other require. properties or context. options too.
require.
context.
"jsdoc/require-jsdoc": [ 'error', { checkConstructors: false, publicOnly: true, require: { 'MethodDefinition': true } } ],
export class MyClass { public myPublicMethod(): void { } /* ^ Missing JSDoc comment. eslint(jsdoc/require-jsdoc) - expected ✅ */ private myPrivateMethod(): void { } /* ^ Missing JSDoc comment. eslint(jsdoc/require-jsdoc) - unexpected ❌ */ // ... }
eslint-plugin-jsdoc
The text was updated successfully, but these errors were encountered:
fix(require-jsdoc): do not report MethodDefinition with non-publi…
require-jsdoc
MethodDefinition
7148307
…c `accessibility`; fixes gajus#1124
accessibility
00922c3
…c `accessibility`; fixes #1124
🎉 This issue has been resolved in version 46.4.2 🎉
The release is available on:
Your semantic-release bot 📦🚀
Sorry, something went wrong.
Thank you @brettz9!
Successfully merging a pull request may close this issue.
Split from #1122.
Expected behavior
When using
jsdoc/require-jsdoc
I would expectpublicOnly
andrequire.MethodDefinition
together to mean that public methods required docs.Actual behavior
Private/protected methods are also failing the lint check too (unexpectedly).
I imagine this issue unexpectedly would apply to other
require.
properties orcontext.
options too.ESLint Config
ESLint sample
Environment
eslint-plugin-jsdoc
version: 46.4.1The text was updated successfully, but these errors were encountered: