Squiz/VariableComment: make errorcode for "TagNotAllowed" warning modular #1039
Conversation
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
…ular As things are, the `VariableComment` sniff only allows `@see` tags and `@var` tags in property docblocks. This practice feels dated to me, as commonly used tags, such as `@link`, `@deprecated` etc are not allowed. This commit replaces the generic `TagNotAllowed` error code in the sniff with a more modular `[TagName]TagNotAllowed` error code. This allows for rulesets to selectively ignore the `TagNotAllowed` error code for specific tags the ruleset maintainer wants to allow for the code base under scan. Includes tests.
... for this codebase.
jrfnl
force-pushed
the
phpcs-4.0/feature/squiz-variablecomment-make-tagnotallowed-modular
branch
from
870e42b to
20994a2
Compare
|
Rebased without changes. Merging once the build has passed. |
jrfnl
deleted the
phpcs-4.0/feature/squiz-variablecomment-make-tagnotallowed-modular
branch
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.
Description
Squiz/VariableComment: make errorcode for "TagNotAllowed" warning modular
As things are, the
VariableCommentsniff only allows@seetags and@vartags in property docblocks.This practice feels dated to me, as commonly used tags, such as
@link,@deprecatedetc are not allowed.This commit replaces the generic
TagNotAllowederror code in the sniff with a more modular[TagName]TagNotAllowederror code.This allows for rulesets to selectively ignore the
TagNotAllowederror code for specific tags the ruleset maintainer wants to allow for the code base under scan.Includes tests.
CS: allow @link and @deprecated in property docblocks
... for this codebase.
Suggested changelog entry
Changed:
Squiz.Commenting.VariableComment.TagNotAllowedhas been replaced by a dynamicSquiz.Commenting.VariableComment.[TagName]TagNotAllowederror code.@linktags in property docblocks, exclude theSquiz.Commenting.VariableComment.LinkTagNotAllowederror code.Related issues/external references
Loosely related to #122