Ruleset: hard deprecate support for standards called "Internal" #893
+12
−0
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
Support for standards called `Internal` was soft deprecated in PHPCS 3.12.0 This PR adds a new Ruleset deprecation notice for when such a standard would be requested from a ruleset. Support for sniffs not following the naming conventions will be removed in PHPCS 4.0. Includes test. Related to 799
rodrigoprimo
approved these changes
Mar 21, 2025
| @@ -892,6 +892,13 @@ private function expandSniffDirectory($directory, $depth=0) | |||
| */ | |||
| private function expandRulesetReference($ref, $rulesetDir, $depth=0) | |||
| { | |||
| // Naming an (external) standard "Internal" is deprecated. | |||
| if (strtolower($ref) === 'internal') { | |||
| $message = 'The name "Internal" is reserved for internal use. A PHP_CodeSniffer standard should not be called "Internal".'.PHP_EOL; | |||
There was a problem hiding this comment.
I tried to remove one use of "internal" from the message to avoid repeating it three times. I came up with the following suggestion:
Suggested change
| $message = 'The name "Internal" is reserved for internal use. A PHP_CodeSniffer standard should not be called "Internal".'.PHP_EOL; | |
| $message = 'The name "Internal" is reserved for internal use. A PHP_CodeSniffer standard should not it.'.PHP_EOL; |
What do you think? This is just a nitpick. Feel free to ignore it.
There was a problem hiding this comment.
@rodrigoprimo The suggested change is a grammatical error. Want to have another look ?
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
Support for standards called
Internalwas soft deprecated in PHPCS 3.12.0This PR adds a new Ruleset deprecation notice for when such a standard would be requested from a ruleset.
Support for sniffs not following the naming conventions will be removed in PHPCS 4.0.
Includes test.
Suggested changelog entry
Added deprecation notices (hard deprecation) for:
Internal, which will no longer be supported in PHPCS 4.0.Related issues/external references
Related to #799