Try eslint-plugin-require-jsdoc-except
drop-in require-jsdoc
ESLint rule
#4506
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Have ESLint not throw
require-jsdoc
for methods.Try
eslint-plugin-require-jsdoc-except
drop-inrequire-jsdoc
ESLint ruleReference: #4504 #4245
Bumped into this https://github.com/MaienM/eslint-plugin-require-jsdoc-except
require-jsdoc
drop-in rule that allows you to exclude certain methods from requiring a JSDoc.How Has This Been Tested?
run
npm run lint
I've also left in the
"ignore": ["constructor", "render"]
option for completeness though it's not required asMethodDefinition
has been definedfalse
Screenshots (jpeg or gifs if applicable):
Types of changes
ESLint JSDoc linting
Checklist: