Skip to content
New issue

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

jsdoc: Extend from plugin:jsdoc/recommended #283

Merged
merged 3 commits into from
Jun 15, 2020
Merged

jsdoc: Extend from plugin:jsdoc/recommended #283

merged 3 commits into from
Jun 15, 2020

Conversation

edg2s
Copy link
Member

@edg2s edg2s commented Jun 12, 2020

All errors are now warnings.
The following rules are now enabled:

  • jsdoc/check-access
  • jsdoc/require-param
  • jsdoc/require-param-name
  • jsdoc/require-param-type
  • jsdoc/require-property-type
  • jsdoc/require-returns
  • jsdoc/require-returns-check
  • jsdoc/require-returns-type

Assert all the rules of jsdoc/recommended in the test fixture.

"// Valid:" comments are not asserted in any way. They just
show which rule we are giving an valid example of.

"// Off:" comments are when a rule has explicitly been turned
off and we will assert that it is present in the valid fixture.

We can now assert that enabled rules are never documented as "Off:".
All errors are now warnings.
The following rules are now enabled:
* jsdoc/check-access
* jsdoc/require-param
* jsdoc/require-param-name
* jsdoc/require-param-type
* jsdoc/require-property-type
* jsdoc/require-returns
* jsdoc/require-returns-check
* jsdoc/require-returns-type

Assert all the rules of jsdoc/recommended in the test fixture.
@edg2s edg2s requested a review from jdforrester June 12, 2020 16:52
@edg2s
Copy link
Member Author

edg2s commented Jun 12, 2020

Should be rebased after #282

@jdforrester jdforrester merged commit d833e5f into master Jun 15, 2020
@jdforrester jdforrester deleted the jsdoc branch June 15, 2020 13:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants