Miscellaneous other changes after dropping JS/CSS support

Closes squizlabs/PHP_CodeSniffer 2448

Related to 6

Author: jrfnl

.cspell.json

@@ -3,8 +3,8 @@
     "dictionaries": ["php"],
     "allowCompoundWords": true,
     "ignorePaths": [
-        "src/Standards/*/Tests/*/*.{inc,js,css}",
-        "src/Standards/*/Tests/*/*.{inc,js,css}.fixed"
+        "src/Standards/*/Tests/*/*.inc",
+        "src/Standards/*/Tests/*/*.inc.fixed"
     ],
     "ignoreRegExpList": ["email", "^\\s+\\*\\s+@(author|copyright)\\s+.*$"],
     "words": [

.github/CONTRIBUTING.md

@@ -265,8 +265,6 @@ To help you with this, a number of convenience scripts are available:
     which will be placed in a `build/coverage-html` subdirectory.
 * `composer build` will build the phpcs.phar and phpcbf.phar files.
 
-N.B.: You can ignore any skipped tests as these are for external tools.
-
 
 ### Writing Tests
 

.github/workflows/quicktest.yml

@@ -20,7 +20,7 @@ concurrency:
 jobs:
   #### QUICK TEST ####
   # This is a much quicker test run which only runs the unit tests against the low/medium/high
-  # supported PHP versions and skips the PHAR test and the tests for external JS/CSS tooling.
+  # supported PHP versions and skips the PHAR test.
   # These are basically the same builds as in the Test->Coverage workflow, but then without doing
   # the code-coverage.
   quicktest:

README.md

@@ -20,7 +20,7 @@
 
 ## About
 
-PHP_CodeSniffer is a set of two PHP scripts; the main `phpcs` script that tokenizes PHP, JavaScript and CSS files to detect violations of a defined coding standard, and a second `phpcbf` script to automatically correct coding standard violations. PHP_CodeSniffer is an essential development tool that ensures your code remains clean and consistent.
+PHP_CodeSniffer is a set of two PHP scripts; the main `phpcs` script that tokenizes PHP files to detect violations of a defined coding standard, and a second `phpcbf` script to automatically correct coding standard violations. PHP_CodeSniffer is an essential development tool that ensures your code remains clean and consistent.
 
 
 ## Requirements

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "squizlabs/php_codesniffer",
-    "description": "PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.",
+    "description": "PHP_CodeSniffer tokenizes PHP files and detects violations of a defined set of coding standards.",
     "license": "BSD-3-Clause",
     "type": "library",
     "keywords": [

phpcs.xml.dist

@@ -9,8 +9,8 @@
     <file>src</file>
     <file>tests</file>
 
-    <exclude-pattern>*/src/Standards/*/Tests/*\.(inc|css|js)$</exclude-pattern>
-    <exclude-pattern>*/tests/Core/*/*\.(inc|css|js)$</exclude-pattern>
+    <exclude-pattern>*/src/Standards/*/Tests/*\.inc$</exclude-pattern>
+    <exclude-pattern>*/tests/Core/*/*\.inc$</exclude-pattern>
     <exclude-pattern>*/tests/Core/*/Fixtures/*\.php$</exclude-pattern>
 
     <arg name="basepath" value="."/>

tests/Core/AbstractMethodUnitTest.php

@@ -19,16 +19,6 @@
 abstract class AbstractMethodUnitTest extends TestCase
 {
 
-    /**
-     * The file extension of the test case file (without leading dot).
-     *
-     * This allows child classes to overrule the default `inc` with, for instance,
-     * `js` or `css` when applicable.
-     *
-     * @var string
-     */
-    protected static $fileExtension = 'inc';
-
     /**
      * The tab width setting to use when tokenizing the file.
      *
@@ -68,7 +58,7 @@ public static function initializeFile()
         // Default to a file with the same name as the test class. Extension is property based.
         $relativeCN     = str_replace(__NAMESPACE__, '', get_called_class());
         $relativePath   = str_replace('\\', DIRECTORY_SEPARATOR, $relativeCN);
-        $pathToTestFile = realpath(__DIR__).$relativePath.'.'.static::$fileExtension;
+        $pathToTestFile = realpath(__DIR__).$relativePath.'.inc';
 
         // Make sure the file gets parsed correctly based on the file type.
         $contents  = 'phpcs_input_file: '.$pathToTestFile.PHP_EOL;
@@ -100,9 +90,8 @@ public static function reset()
             self::$phpcsFile->config->__destruct();
         }
 
-        self::$fileExtension = 'inc';
-        self::$tabWidth      = 4;
-        self::$phpcsFile     = null;
+        self::$tabWidth  = 4;
+        self::$phpcsFile = null;
 
     }//end reset()
 

tests/Core/Ruleset/PopulateTokenListenersTest.php

@@ -390,7 +390,7 @@ public function testSetsIncludeAndIgnorePatterns($token, $sniffClass, $patternTy
         $expected = [
             '/no-transformation/',
             '/simple.*transformation/.*',
-            '/escaped\\,comma/becomes/comma/to/allow/commas/in/filenames.css',
+            '/escaped\\,comma/becomes/comma/to/allow/commas/in/filenames.inc',
             '/pat?tern(is|regex)\\.php$',
         ];
 

tests/Core/Ruleset/PopulateTokenListenersTest.xml

@@ -27,15 +27,15 @@
     <rule ref="Generic.NamingConventions.UpperCaseConstantName">
         <include-pattern>/no-transformation/</include-pattern>
         <include-pattern>/simple*transformation/*</include-pattern>
-        <include-pattern>/escaped\\,comma/becomes/comma/to/allow/commas/in/filenames.css</include-pattern>
+        <include-pattern>/escaped\\,comma/becomes/comma/to/allow/commas/in/filenames.inc</include-pattern>
         <include-pattern>/pat?tern(is|regex)\.php$</include-pattern>
     </rule>
 
     <!-- Test handling of exclude patterns. -->
     <rule ref="PSR1.Files.SideEffects">
         <exclude-pattern>/no-transformation/</exclude-pattern>
         <exclude-pattern>/simple*transformation/*</exclude-pattern>
-        <exclude-pattern>/escaped\\,comma/becomes/comma/to/allow/commas/in/filenames.css</exclude-pattern>
+        <exclude-pattern>/escaped\\,comma/becomes/comma/to/allow/commas/in/filenames.inc</exclude-pattern>
         <exclude-pattern>/pat?tern(is|regex)\.php$</exclude-pattern>
     </rule>
 

tests/Core/Tokenizers/AbstractTokenizerTestCase.php

@@ -22,16 +22,6 @@
 abstract class AbstractTokenizerTestCase extends TestCase
 {
 
-    /**
-     * The file extension of the test case file (without leading dot).
-     *
-     * This allows child classes to overrule the default `inc` with, for instance,
-     * `js` or `css` when applicable.
-     *
-     * @var string
-     */
-    protected $fileExtension = 'inc';
-
     /**
      * The tab width setting to use when tokenizing the file.
      *
@@ -73,7 +63,7 @@ protected function initializeFile()
             // Default to a file with the same name as the test class. Extension is property based.
             $relativeCN     = str_replace(__NAMESPACE__, '', get_called_class());
             $relativePath   = str_replace('\\', DIRECTORY_SEPARATOR, $relativeCN);
-            $pathToTestFile = realpath(__DIR__).$relativePath.'.'.$this->fileExtension;
+            $pathToTestFile = realpath(__DIR__).$relativePath.'.inc';
 
             // Make sure the file gets parsed correctly based on the file type.
             $contents  = 'phpcs_input_file: '.$pathToTestFile.PHP_EOL;