Skip to content

Conversation

@ntwb
Copy link
Member

@ntwb ntwb commented Jan 16, 2018

Description

Have ESLint not throw require-jsdoc for methods.

Try eslint-plugin-require-jsdoc-except drop-in require-jsdoc ESLint rule

Reference: #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 as MethodDefinition has been defined false

Screenshots (jpeg or gifs if applicable):

Types of changes

ESLint JSDoc linting

Checklist:

  • My code is tested.
  • My code follows the WordPress code style.
  • My code follows has proper inline documentation.

@ntwb ntwb requested review from atimmer and pento January 16, 2018 11:00
@pento
Copy link
Member

pento commented Jan 16, 2018

Nice. The warnings are still super spammy, though - can they be moved out of the npm run lint command for now? I don't mind there being a separate command for whoever wants to go through and fix them all, but they shouldn't be getting in the way of day-to-day work.

@ntwb ntwb mentioned this pull request Jan 16, 2018
3 tasks
@ntwb ntwb added the [Type] Build Tooling Issues or PRs related to build tooling label Jan 16, 2018
@ntwb
Copy link
Member Author

ntwb commented Jan 16, 2018

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

@ntwb
Copy link
Member Author

ntwb commented Jan 16, 2018

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

@ntwb ntwb self-assigned this Jan 16, 2018
@aduth aduth mentioned this pull request Jan 19, 2018
3 tasks
@aduth
Copy link
Member

aduth commented Mar 16, 2018

@ntwb Will you be able to revisit this one?

@aduth aduth added the [Status] Stale Gives the original author opportunity to update before closing. Can be reopened as needed. label Mar 16, 2018
@ntwb ntwb mentioned this pull request Apr 22, 2018
4 tasks
@ntwb
Copy link
Member Author

ntwb commented Apr 22, 2018

@ntwb Will you be able to revisit this one?

Apologies @aduth, I missed this, a new PR for this is available in #6341

@ntwb ntwb closed this Apr 22, 2018
@ntwb ntwb deleted the try/eslint-plugin-require-jsdoc-except branch April 22, 2018 09:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[Status] Stale Gives the original author opportunity to update before closing. Can be reopened as needed. [Type] Build Tooling Issues or PRs related to build tooling

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants