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

feat: Add require-throws-type rule #906

Closed
wants to merge 1 commit into from

Conversation

jomarquez21
Copy link

No description provided.

@jomarquez21 jomarquez21 changed the title Add require-throws-type rule feat: Add require-throws-type rule Aug 22, 2022
@brettz9
Copy link
Collaborator

brettz9 commented Aug 24, 2022

Thanks for the PR.

One can currently get this functionality by using:

      settings: {
        jsdoc: {
          structuredTags: {
            throws: {
              required: [
                'type',
              ],
            },
          },
        },
      },

I think this approach keeps things simpler (one might also want to ensure the likes of @typedef has a type too, even if the spec doesn't require it).

We might offer a config in the future along the lines of #701 which offered a mode with such reasonable stricter default settings.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants