Merge pull request #893 from PHPCSStandards/feature/799-ruleset-remove-support-for-standard-internal

Ruleset: hard deprecate support for standards called "Internal"

Author: jrfnl

src/Ruleset.php

@@ -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;
+            $message .= 'Contact the maintainer of the standard to fix this.';
+            $this->msgCache->add($message, MessageCollector::DEPRECATED);
+        }
+
         // Ignore internal sniffs codes as they are used to only
         // hide and change internal messages.
         if (substr($ref, 0, 9) === 'Internal.') {

tests/Core/Ruleset/ExpandRulesetReferenceInternalTest.php

@@ -51,6 +51,11 @@ public function testInternalRefDoesNotGetExpanded()
      */
     public function testInternalStandardDoesGetExpanded()
     {
+        $message  = 'DEPRECATED: The name "Internal" is reserved for internal use. A PHP_CodeSniffer standard should not be called "Internal".'.PHP_EOL;
+        $message .= 'Contact the maintainer of the standard to fix this.'.PHP_EOL.PHP_EOL;
+
+        $this->expectOutputString($message);
+
         // Set up the ruleset.
         $standard = __DIR__.'/ExpandRulesetReferenceInternalStandardTest.xml';
         $config   = new ConfigDouble(["--standard=$standard"]);