Add eslint support for semver validation and optional description to @since tag#70734
Open
USERSATOSHI wants to merge 1 commit intoWordPress:trunkfrom
Open
Add eslint support for semver validation and optional description to @since tag#70734USERSATOSHI wants to merge 1 commit intoWordPress:trunkfrom
@since tag#70734USERSATOSHI wants to merge 1 commit intoWordPress:trunkfrom
Conversation
@since jsdoc@since tag
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the Unlinked AccountsThe following contributors have not linked their GitHub and WordPress.org accounts: @sainthkh. Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases. If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
This file contains hidden or 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
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.
What?
Closes #20859
This PR adds supports for adding semver validation and optional description for
@sincetag in JSDocWhy?
While #20427 ( increasing severity of
eslint-plugin-jsdoc) was being worked on, It was found that, It flagged description/explanation after the version in@sincewhich is a frequently-used pattern in WordPress projects.Due to this,
jsdoc/check-valueswas disabled to prevent errors but this leads to manually checking versions in@since.This PR adds supports for semver validation on
@sincewhile also adding support for optional description.How?
This PR adds a custom
@wordpress/require-valid-since( name can be changed ) which checks for proper semver versions in@sincetag while also allowing optional description.Testing Instructions
Added Unit Tests should suffice for testing
Screenshots or screencast