Try eslint-plugin-require-jsdoc-except drop-in require-jsdoc ESLint rule#4506
Closed
Try eslint-plugin-require-jsdoc-except drop-in require-jsdoc ESLint rule#4506
eslint-plugin-require-jsdoc-except drop-in require-jsdoc ESLint rule#4506Conversation
Member
|
Nice. The warnings are still super spammy, though - can they be moved out of the |
3 tasks
Member
Author
|
Let's merge #4510 now and get rid of these warnings for now and follow up by way of discussion this PRs merits over the coming days and iterate as/if needed |
atimmer
approved these changes
Jan 16, 2018
Member
Author
|
FYI: Don't merge this PR please, we should look to moving any JSDoc ESLint linting to a separate lint task that doesn't affect other contributors |
Member
|
@ntwb Will you be able to revisit this one? |
Member
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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-jsdocfor methods.Try
eslint-plugin-require-jsdoc-exceptdrop-inrequire-jsdocESLint ruleReference: #4504 #4245
Bumped into this https://github.com/MaienM/eslint-plugin-require-jsdoc-except
require-jsdocdrop-in rule that allows you to exclude certain methods from requiring a JSDoc.How Has This Been Tested?
run
npm run lintI've also left in the
"ignore": ["constructor", "render"]option for completeness though it's not required asMethodDefinitionhas been definedfalseScreenshots (jpeg or gifs if applicable):
Types of changes
ESLint JSDoc linting
Checklist: