feat: structuredTags setting to control type/name portions of existing or custom tags
#610
Conversation
This file contains 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
…uredTags` setting to control whether the type and namepath portions should be checked for validity and whether such portions are required, and to let user-defined "namepath-defining" tags be added to defined types. Closes gajus#481 BREAKING CHANGE: Drops `checkSeesForNamepaths` setting. Use `{settings: {jsdoc: {structuredTags: {name: 'namepath', type: false, required: ['name'],}}}}` instead. Also: 1. Clarifies in more cases where a problem is specific to the mode or not 2. Reports simultaneous invalid name *and* type errors 3. `typdef` now requires `allowEmptyNamepaths: false,` to report empty names (as with other tags) 4. Requires a name for `event` and `external` (and `extends` in jsdoc mode); some tweaking of other tags per docs
brettz9
force-pushed
the
valid-types-tags
branch
from
0c4582c
to
8281a64
Compare
|
Unless there are objections, I'm thinking of also changing this PR to make |
… ensuring tags which expect names per docs will be reported Also ensures `see` tag with only an inline link tag is not treated as empty.
|
🎉 This PR is included in version 30.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
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.
feat(
check-types,no-undefined-types,valid-types): AddstructuredTagssetting to control whether the type and namepath portions should be checked for validity and whether such portions are required, and to let user-defined "namepath-defining" tags be added to defined types. Closes #481BREAKING CHANGE:
Drops
checkSeesForNamepathssetting. Use{settings: {jsdoc: {structuredTags: {name: 'namepath', type: false, required: ['name'],}}}}instead.Also:
typdefnow requiresallowEmptyNamepaths: false,to report empty names (as with other tags)eventandexternal(andextendsin jsdoc mode); some tweaking of other tags per docs(Also does some jsdocUtil refactoring along the way to pull tag meta-data all into one map for easier management and to minimize tag-specific handling blocks within
valid-types.)(Since settings can now throw, needed to add a test to a few other rules to cover such cases.)