NonceVerification: use separate errorcodes for warning vs error #1487
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
GaryJones
added
Status: Requirement not met
jrfnl
force-pushed
the
feature/nonce-verification-errorcodes
branch
from
88fe6ae to
1696b85
Compare
While cleaning up a plugin, I noticed that the issue count for the `WordPress.Security.NonceVerification.NoNonceVerification` error code was different if I ran phpcs with the `-n` flag (no warnings). Error codes should be unique. Having the same error code for something which is mandatory (`error`) and recommended (`warning`) is bad practice and does not properly allow for modular disabling of notices. This PR fixes this. As the error code is changing anyhow, I figured it made sense to also remove the duplication of the sniff name from the code. This is a breaking change as `<exclude>`s for the old errorcode currently in custom rulesets will be invalidated by it, so this PR should go into WPCS 2.0.0. N.B.: The ruleset change is necessary until the deprecated sniffs have been removed.
jrfnl
force-pushed
the
feature/nonce-verification-errorcodes
branch
from
1696b85 to
7b920b4
Compare
|
Rebased. Once the build passes, this one should now be considered ready for review. |
GaryJones
approved these changes
Dec 18, 2018
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.
While cleaning up a plugin, I noticed that the issue count for the
WordPress.Security.NonceVerification.NoNonceVerificationerror code was different if I ran phpcs with the-nflag (no warnings).Error codes should be unique. Having the same error code for something which is mandatory (
error) and recommended (warning) is bad practice and does not properly allow for modular disabling of notices.This PR fixes this.
As the error code is changing anyhow, I figured it made sense to also remove the duplication of the sniff name from the code.
This is a breaking change as
<exclude>s for the old errorcode currently in custom rulesets will be invalidated by it, as well as inline annotations using the error code, so this PR should go into WPCS 2.0.0.N.B.: The ruleset change is only necessary until the deprecated sniffs have been removed.