Skip to content

Conversation

brettz9
Copy link
Collaborator

@brettz9 brettz9 commented Sep 13, 2025

BREAKING CHANGE:

It is unlikely to affect users but when using the jsdoc constructor with a recommended config , this commit removes throws and yields
from the structuredTags settings recently added to the config output to require types for these tags in favor of the herein added equivalent
recommended rules. (next is still part of structuredTags output, however, because this setting ensures the non-standard next tag is treated
as allowable without need for separate configuration.)

  • feat: extraRuleDefinitions.forbid option to jsdoc function

…`): adds new rules and adds to recommended and required configs; fixes gajus#1461

BREAKING CHANGE:

It is unlikely to affect users but when using the jsdoc constructor with a recommended config , this commit removes `throws` and `yields`
from the `structuredTags` settings recently added to the config output to require types for these tags in favor of the herein added equivalent
recommended rules. (`next` is still part of `structuredTags` output, however, because this setting ensures the non-standard next tag is treated
as allowable without need for separate configuration.)

Also:
- chore: remove unused linting directives
@brettz9 brettz9 merged commit 0645428 into gajus:main Sep 13, 2025
4 checks passed
Copy link

🎉 This PR is included in version 57.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Successfully merging this pull request may close these issues.

new rules: require-throws-type, require-yields-type
1 participant