Merge pull request #894 from PHPCSStandards/feature/740-ruleset-show-deprecation-sniffs-scanning-js-css-files

Ruleset: hard deprecate $supportedTokenizers set to CSS/JS only

Author: jrfnl

src/Ruleset.php

@@ -1489,7 +1489,9 @@ public function populateTokenListeners()
 
             $this->sniffCodes[$sniffCode] = $sniffClass;
 
+            $isDeprecated = false;
             if ($this->sniffs[$sniffClass] instanceof DeprecatedSniff) {
+                $isDeprecated = true;
                 $this->deprecatedSniffs[$sniffCode] = $sniffClass;
             }
 
@@ -1502,6 +1504,24 @@ public function populateTokenListeners()
 
             $tokenizers = [];
             $vars       = get_class_vars($sniffClass);
+            if (empty($vars['supportedTokenizers']) === false
+                && $isDeprecated === false
+                && in_array('PHP', $vars['supportedTokenizers'], true) === false
+            ) {
+                if (in_array('CSS', $vars['supportedTokenizers'], true) === true
+                    || in_array('JS', $vars['supportedTokenizers'], true) === true
+                ) {
+                    $message = 'Scanning CSS/JS files is deprecated and support will be removed in PHP_CodeSniffer 4.0.'.PHP_EOL;
+                } else {
+                    // Just in case someone has an integration with a custom tokenizer.
+                    $message = 'Support for custom tokenizers will be removed in PHP_CodeSniffer 4.0.'.PHP_EOL;
+                }
+
+                $message .= 'The %s sniff is listening for %s.';
+                $message  = sprintf($message, $sniffCode, implode(', ', $vars['supportedTokenizers']));
+                $this->msgCache->add($message, MessageCollector::DEPRECATED);
+            }
+
             if (isset($vars['supportedTokenizers']) === true) {
                 foreach ($vars['supportedTokenizers'] as $tokenizer) {
                     $tokenizers[$tokenizer] = $tokenizer;

tests/Core/Filters/Filter/AcceptTest.xml

@@ -8,6 +8,8 @@
     <exclude-pattern>*/Other/Main\.php$</exclude-pattern>
 
     <rule ref="Generic">
+        <exclude name="Generic.Debug"/>
+
         <!-- Standard specific directory pattern. -->
         <exclude-pattern>/anything/*</exclude-pattern>
         <!-- Standard specific file pattern. -->

tests/Core/Ruleset/Fixtures/TestStandard/Sniffs/SupportedTokenizers/ImplementsDeprecatedInterfaceSniff.php

@@ -0,0 +1,46 @@
+<?php
+/**
+ * Test fixture.
+ *
+ * @see \PHP_CodeSniffer\Tests\Core\Ruleset\PopulateTokenListenersSupportedTokenizersTest
+ */
+
+namespace Fixtures\TestStandard\Sniffs\SupportedTokenizers;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\DeprecatedSniff;
+use PHP_CodeSniffer\Sniffs\Sniff;
+
+class ImplementsDeprecatedInterfaceSniff implements Sniff, DeprecatedSniff
+{
+
+    public $supportedTokenizers = [
+        'CSS',
+        'JS',
+    ];
+
+    public function getDeprecationVersion()
+    {
+        return 'v3.4.0';
+    }
+
+    public function getRemovalVersion()
+    {
+        return 'v4.0.0';
+    }
+
+    public function getDeprecationMessage()
+    {
+        return '';
+    }
+
+    public function register()
+    {
+        return [T_WHITESPACE];
+    }
+
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        // Do something.
+    }
+}

tests/Core/Ruleset/Fixtures/TestStandard/Sniffs/SupportedTokenizers/ListensForCSSAndJSSniff.php

@@ -0,0 +1,30 @@
+<?php
+/**
+ * Test fixture.
+ *
+ * @see \PHP_CodeSniffer\Tests\Core\Ruleset\PopulateTokenListenersSupportedTokenizersTest
+ */
+
+namespace Fixtures\TestStandard\Sniffs\SupportedTokenizers;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+
+class ListensForCSSAndJSSniff implements Sniff
+{
+
+    public $supportedTokenizers = [
+        'CSS',
+        'JS',
+    ];
+
+    public function register()
+    {
+        return [T_WHITESPACE];
+    }
+
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        // Do something.
+    }
+}

tests/Core/Ruleset/Fixtures/TestStandard/Sniffs/SupportedTokenizers/ListensForCSSAndUnrecognizedSniff.php

@@ -0,0 +1,30 @@
+<?php
+/**
+ * Test fixture.
+ *
+ * @see \PHP_CodeSniffer\Tests\Core\Ruleset\PopulateTokenListenersSupportedTokenizersTest
+ */
+
+namespace Fixtures\TestStandard\Sniffs\SupportedTokenizers;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+
+class ListensForCSSAndUnrecognizedSniff implements Sniff
+{
+
+    public $supportedTokenizers = [
+        'CSS',
+        'Unrecognized',
+    ];
+
+    public function register()
+    {
+        return [T_WHITESPACE];
+    }
+
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        // Do something.
+    }
+}

tests/Core/Ruleset/Fixtures/TestStandard/Sniffs/SupportedTokenizers/ListensForCSSSniff.php

@@ -0,0 +1,27 @@
+<?php
+/**
+ * Test fixture.
+ *
+ * @see \PHP_CodeSniffer\Tests\Core\Ruleset\PopulateTokenListenersSupportedTokenizersTest
+ */
+
+namespace Fixtures\TestStandard\Sniffs\SupportedTokenizers;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+
+class ListensForCSSSniff implements Sniff
+{
+
+    public $supportedTokenizers = ['CSS'];
+
+    public function register()
+    {
+        return [T_WHITESPACE];
+    }
+
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        // Do something.
+    }
+}

tests/Core/Ruleset/Fixtures/TestStandard/Sniffs/SupportedTokenizers/ListensForEmptySniff.php

@@ -0,0 +1,27 @@
+<?php
+/**
+ * Test fixture.
+ *
+ * @see \PHP_CodeSniffer\Tests\Core\Ruleset\PopulateTokenListenersSupportedTokenizersTest
+ */
+
+namespace Fixtures\TestStandard\Sniffs\SupportedTokenizers;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+
+class ListensForEmptySniff implements Sniff
+{
+
+    public $supportedTokenizers = [];
+
+    public function register()
+    {
+        return [T_WHITESPACE];
+    }
+
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        // Do something.
+    }
+}

tests/Core/Ruleset/Fixtures/TestStandard/Sniffs/SupportedTokenizers/ListensForJSSniff.php

@@ -0,0 +1,27 @@
+<?php
+/**
+ * Test fixture.
+ *
+ * @see \PHP_CodeSniffer\Tests\Core\Ruleset\PopulateTokenListenersSupportedTokenizersTest
+ */
+
+namespace Fixtures\TestStandard\Sniffs\SupportedTokenizers;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+
+class ListensForJSSniff implements Sniff
+{
+
+    public $supportedTokenizers = ['JS'];
+
+    public function register()
+    {
+        return [T_WHITESPACE];
+    }
+
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        // Do something.
+    }
+}

tests/Core/Ruleset/Fixtures/TestStandard/Sniffs/SupportedTokenizers/ListensForPHPAndCSSAndJSSniff.php

@@ -0,0 +1,34 @@
+<?php
+/**
+ * Test fixture.
+ *
+ * @see \PHP_CodeSniffer\Tests\Core\Ruleset\PopulateTokenListenersSupportedTokenizersTest
+ */
+
+namespace Fixtures\TestStandard\Sniffs\SupportedTokenizers;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+
+class ListensForPHPAndCSSAndJSSniff implements Sniff
+{
+
+    public $supportedTokenizers = [
+        'PHP',
+        'JS',
+        'CSS',
+    ];
+
+    public function register()
+    {
+        return [
+            T_OPEN_TAG,
+            T_OPEN_TAG_WITH_ECHO
+        ];
+    }
+
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        // Do something.
+    }
+}

tests/Core/Ruleset/Fixtures/TestStandard/Sniffs/SupportedTokenizers/ListensForUnrecognizedTokenizersSniff.php

@@ -0,0 +1,30 @@
+<?php
+/**
+ * Test fixture.
+ *
+ * @see \PHP_CodeSniffer\Tests\Core\Ruleset\PopulateTokenListenersSupportedTokenizersTest
+ */
+
+namespace Fixtures\TestStandard\Sniffs\SupportedTokenizers;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+
+class ListensForUnrecognizedTokenizersSniff implements Sniff
+{
+
+    public $supportedTokenizers = [
+        'SCSS',
+        'TypeScript',
+    ];
+
+    public function register()
+    {
+        return [T_WHITESPACE];
+    }
+
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        // Do something.
+    }
+}