From 47646d690553aeab0dcb7a2057b0320d2694adfd Mon Sep 17 00:00:00 2001
From: jrfnl <jrfnl@users.noreply.github.com>
Date: Tue, 1 Sep 2020 04:17:57 +0200
Subject: [PATCH 01/17] QA/CS: update PHPCSDevCS

The new `1.1.x` version already includes a check for short array syntax, so we can remove that from our own ruleset.
---
 composer.json  | 2 +-
 phpcs.xml.dist | 3 ---
 2 files changed, 1 insertion(+), 4 deletions(-)

diff --git a/composer.json b/composer.json
index e8abe93..703095e 100644
--- a/composer.json
+++ b/composer.json
@@ -29,7 +29,7 @@
         "phpunit/phpunit" : "^4.5 || ^5.0 || ^6.0 || ^7.0",
         "php-parallel-lint/php-parallel-lint": "^1.0",
         "php-parallel-lint/php-console-highlighter": "^0.5",
-        "phpcsstandards/phpcsdevcs": "^1.0"
+        "phpcsstandards/phpcsdevcs": "^1.1.1"
     },
     "bin": [
         "bin/phpcs-check-feature-completeness"
diff --git a/phpcs.xml.dist b/phpcs.xml.dist
index 6d60988..27496a6 100644
--- a/phpcs.xml.dist
+++ b/phpcs.xml.dist
@@ -44,9 +44,6 @@
     <!-- Set minimum PHP version supported to PHP 5.4. -->
     <config name="testVersion" value="5.4-"/>
 
-    <!-- Enforce short arrays. -->
-    <rule ref="Generic.Arrays.DisallowLongArraySyntax"/>
-
 
     <!--
     #############################################################################

From 34d0bedc32bb1c5d56351ba93a639037f762d103 Mon Sep 17 00:00:00 2001
From: Juliette <663378+jrfnl@users.noreply.github.com>
Date: Thu, 3 Sep 2020 20:12:26 +0200
Subject: [PATCH 02/17] PHPCSDebug/Tests: change set up

Change the test setup from being based on the test suite in PHPCS to using the PHPCSUtils `UtilityMethodTestCase` as a basis.

That should stabilize the test, as well as allow the test to run without problems on higher PHPUnit/PHP versions.

### Added:
* Composer:
    - Dev dependency on PHPCSUtils. Only needed for running the tests.
        Does - for now - require a minimum stability of `dev` though.
    - A wider range of PHPUnit versions as the PHPCSUtils test case is compatible with these.
* Test bootstrap:
    - Define some PHPCS constants which are expected for the test run.
    - Loading of the PHPCSUtils autoload file.
        To run the tests locally using git clones instead of a Composer setup, make sure to set a `PHPCSUTILS_DIR` environment variable pointing to the clone of PHPCSUtils.
    - Loading of the PHPCS native `Tokens` class to prevent issues with tokens not being defined.

### Changed:
* Composer:
    - Raise the minimum PHPCS requirement to `3.1.0` as otherwise it would conflict with PHPCSUtils.
        :warning: This needs a changelog entry : warning:
    - Remove the arguments for the PHPUnit script. These are no longer needed.
* Tests: Merged the two test files for the one sniff into one file using the `UtilityMethodTestCase` as a base instead of the PHPCS native `AbstractSniffUnitTest`.

### Removed:
* Travis: all PHPUnit versions are now unconditionally supported. PHPUnit support no longer depends on which PHPCS version is installed.
* Travis: PHPCS 4.x does not need to be installed using `--prefer-source` anymore as we're no longer using the PHPCS native test case basis.
* Test bootstrap: the setting of the `PHPCS_IGNORE_TEST` environment variable as it is no longer needed (PHPCS test setup specific).
---
 .travis.yml                                   | 15 +---
 PHPCSDebug/Tests/Debug/TokenListUnitTest.php  | 56 +++++-------
 PHPCSDebug/Tests/Debug/TokenListZUnitTest.php | 46 ----------
 README.md                                     |  2 +-
 composer.json                                 | 11 ++-
 phpunit-bootstrap.php                         | 85 ++++++++++---------
 6 files changed, 77 insertions(+), 138 deletions(-)
 delete mode 100644 PHPCSDebug/Tests/Debug/TokenListZUnitTest.php

diff --git a/.travis.yml b/.travis.yml
index f8be8d6..0db75e2 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -24,7 +24,7 @@ env:
   # PHPCS `master`
   - PHPCS_VERSION="dev-master" LINT=1
   # Lowest supported PHPCS version.
-  - PHPCS_VERSION="3.0.2"
+  - PHPCS_VERSION="3.1.0"
 
 # Define the stages used.
 # For non-PRs, only the sniff and quicktest stages are run.
@@ -72,14 +72,14 @@ jobs:
       env: PHPCS_VERSION="dev-master" LINT=1
     - stage: quicktest
       php: 7.2
-      env: PHPCS_VERSION="3.0.2"
+      env: PHPCS_VERSION="3.1.0"
 
     - stage: quicktest
       php: 5.4
       env: PHPCS_VERSION="dev-master" LINT=1
     - stage: quicktest
       php: 5.4
-      env: PHPCS_VERSION="3.0.2"
+      env: PHPCS_VERSION="3.1.0"
 
     #### TEST STAGE ####
     # Additional builds to prevent issues with PHPCS versions incompatible with certain PHP versions.
@@ -135,12 +135,6 @@ before_install:
     if [[ "${TRAVIS_BUILD_STAGE_NAME^}" == "Sniff" ]]; then
       # The sniff stage doesn't run the unit tests, so no need for PHPUnit.
       composer remove --dev phpunit/phpunit --no-update --no-scripts
-    elif [[ "$PHPCS_VERSION" < "3.1.0" ]]; then
-      # PHPCS < 3.1.0 is not compatible with PHPUnit 6.x.
-      composer require --dev phpunit/phpunit:"^4.0||^5.0" --no-update --no-scripts
-    elif [[ "$PHPCS_VERSION" < "3.2.3" ]]; then
-      # PHPCS < 3.2.3 is not compatible with PHPUnit 7.x.
-      composer require --dev phpunit/phpunit:"^4.0||^5.0||^6.0" --no-update --no-scripts
     fi
 
   # --prefer-dist will allow for optimal use of the travis caching ability.
@@ -149,9 +143,6 @@ before_install:
     if [[ $TRAVIS_PHP_VERSION == "nightly" ]]; then
       # Not all dependencies allow for installing on nightly yet, so ignore platform requirements.
       composer install --prefer-dist --no-suggest --ignore-platform-reqs
-    elif [[ "$PHPCS_VERSION" == "4.0.x-dev" ]]; then
-      # PHPCS 4.x does not ship by default with the base test case, so source is needed.
-      composer install --prefer-source --no-suggest
     else
       composer install --prefer-dist --no-suggest
     fi
diff --git a/PHPCSDebug/Tests/Debug/TokenListUnitTest.php b/PHPCSDebug/Tests/Debug/TokenListUnitTest.php
index 80ed928..d855f32 100644
--- a/PHPCSDebug/Tests/Debug/TokenListUnitTest.php
+++ b/PHPCSDebug/Tests/Debug/TokenListUnitTest.php
@@ -10,7 +10,7 @@
 
 namespace PHPCSDebug\Tests\Debug;
 
-use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+use PHPCSUtils\TestUtils\UtilityMethodTestCase;
 
 /**
  * Unit test class for the TokenList sniff.
@@ -19,57 +19,39 @@
  *
  * @since 1.0.0
  */
-class TokenListUnitTest extends AbstractSniffUnitTest
+class TokenListUnitTest extends UtilityMethodTestCase
 {
 
     /**
-     * Cache any output generated during the test.
+     * Set the name of a sniff to pass to PHPCS to limit the run (and force it to record errors).
      *
-     * @var string
+     * @var array
      */
-    public static $output = '';
+    protected static $selectedSniff = ['PHPCSDebug.Debug.TokenList'];
 
     /**
-     * Sets up this unit test.
+     * Test the actual output of the TokenList sniff.
      *
      * @return void
      */
-    protected function setUp()
+    public function testOutput()
     {
-        parent::setUp();
-
         \ob_start();
-    }
+        self::$phpcsFile->process();
+        $output = \ob_get_flush();
 
-    /**
-     * Clean up.
-     *
-     * @return void
-     */
-    protected function tearDown()
-    {
-        self::$output = \ob_get_flush();
+        $output = \str_replace(["\r\n", "\r"], "\n", $output);
 
-        parent::tearDown();
-    }
+        $this->assertNotEmpty($output);
 
-    /**
-     * Returns the lines where errors should occur.
-     *
-     * @return array <int line number> => <int number of errors>
-     */
-    public function getErrorList()
-    {
-        return [];
-    }
+        $expected  = "\n";
+        $expected .= 'Ptr :: Ln :: Col  :: Cond :: Token Type                 :: [len]: Content' . "\n";
+        $expected .= '-------------------------------------------------------------------------' . "\n";
+        $expected .= '  0 :: L1 :: C  1 :: CC 0 :: T_OPEN_TAG                 :: [5]: <?php' . "\n\n";
+        $expected .= '  1 :: L2 :: C  1 :: CC 0 :: T_WHITESPACE               :: [0]: ' . "\n\n";
+        $expected .= '  2 :: L3 :: C  1 :: CC 0 :: T_FUNCTION                 :: [8]: function' . "\n";
+        $expected .= '  3 :: L3 :: C  9 :: CC 0 :: T_WHITESPACE               :: [0]: ' . "\n\n";
 
-    /**
-     * Returns the lines where warnings should occur.
-     *
-     * @return array <int line number> => <int number of warnings>
-     */
-    public function getWarningList()
-    {
-        return [];
+        $this->assertSame($expected, $output);
     }
 }
diff --git a/PHPCSDebug/Tests/Debug/TokenListZUnitTest.php b/PHPCSDebug/Tests/Debug/TokenListZUnitTest.php
deleted file mode 100644
index 8128955..0000000
--- a/PHPCSDebug/Tests/Debug/TokenListZUnitTest.php
+++ /dev/null
@@ -1,46 +0,0 @@
-<?php
-/**
- * PHPCSDevTools, tools for PHP_CodeSniffer sniff developers.
- *
- * @package   PHPCSDevTools
- * @copyright 2019 PHPCSDevTools Contributors
- * @license   https://opensource.org/licenses/LGPL-3.0 LGPL3
- * @link      https://github.com/PHPCSStandards/PHPCSDevTools
- */
-
-namespace PHPCSDebug\Tests\Debug;
-
-use PHPUnit\Framework\TestCase;
-
-/**
- * Unit test class for the TokenList sniff.
- *
- * @covers PHPCSDebug\Sniffs\Debug\TokenListSniff
- *
- * @since 1.0.0
- */
-class TokenListZUnitTest extends TestCase
-{
-
-    /**
-     * Test the actual output of the TokenList sniff.
-     *
-     * @return void
-     */
-    public function testOutput()
-    {
-        $output = \str_replace(["\r\n", "\r"], "\n", TokenListUnitTest::$output);
-
-        $this->assertNotEmpty($output);
-
-        $expected  = "\n";
-        $expected .= 'Ptr :: Ln :: Col  :: Cond :: Token Type                 :: [len]: Content' . "\n";
-        $expected .= '-------------------------------------------------------------------------' . "\n";
-        $expected .= '  0 :: L1 :: C  1 :: CC 0 :: T_OPEN_TAG                 :: [5]: <?php' . "\n\n";
-        $expected .= '  1 :: L2 :: C  1 :: CC 0 :: T_WHITESPACE               :: [0]: ' . "\n\n";
-        $expected .= '  2 :: L3 :: C  1 :: CC 0 :: T_FUNCTION                 :: [8]: function' . "\n";
-        $expected .= '  3 :: L3 :: C  9 :: CC 0 :: T_WHITESPACE               :: [0]: ' . "\n\n";
-
-        $this->assertSame($expected, $output);
-    }
-}
diff --git a/README.md b/README.md
index fcd1831..65f19ee 100644
--- a/README.md
+++ b/README.md
@@ -122,7 +122,7 @@ Once this project is installed, you will see a new `PHPCSDebug` ruleset in the l
 For now, this standard only contains one sniff: `PHPCSDebug.Debug.TokenList`.
 This sniff will display compact, but detailed information about the tokens found in a (test case) file.
 
-This sniff is compatible with PHPCS 3.0.2+.
+This sniff is compatible with PHPCS 3.1.0+.
 
 Typical usage:
 * Set up a test case file for a new sniff you intend to write.
diff --git a/composer.json b/composer.json
index 703095e..f367b92 100644
--- a/composer.json
+++ b/composer.json
@@ -21,19 +21,22 @@
     },
     "require" : {
         "php" : ">=5.4",
-        "squizlabs/php_codesniffer" : "^3.0.2",
+        "squizlabs/php_codesniffer" : "^3.1.0",
         "dealerdirect/phpcodesniffer-composer-installer" : "^0.4.1 || ^0.5 || ^0.6.2 || ^0.7"
     },
     "require-dev" : {
         "roave/security-advisories" : "dev-master",
-        "phpunit/phpunit" : "^4.5 || ^5.0 || ^6.0 || ^7.0",
+        "phpunit/phpunit" : "^4.5 || ^5.0 || ^6.0 || ^7.0 || ^8.0 || ^9.0",
         "php-parallel-lint/php-parallel-lint": "^1.0",
         "php-parallel-lint/php-console-highlighter": "^0.5",
-        "phpcsstandards/phpcsdevcs": "^1.1.1"
+        "phpcsstandards/phpcsdevcs": "^1.1.1",
+        "phpcsstandards/phpcsutils" : "^1.0"
     },
     "bin": [
         "bin/phpcs-check-feature-completeness"
     ],
+    "minimum-stability": "dev",
+    "prefer-stable": true,
     "scripts" : {
         "lint": [
             "@php ./vendor/php-parallel-lint/php-parallel-lint/parallel-lint . -e php --exclude vendor --exclude .git"
@@ -45,7 +48,7 @@
             "@php ./vendor/squizlabs/php_codesniffer/bin/phpcbf"
         ],
         "run-tests": [
-            "@php ./vendor/phpunit/phpunit/phpunit --filter PHPCSDebug ./vendor/squizlabs/php_codesniffer/tests/AllTests.php"
+            "@php ./vendor/phpunit/phpunit/phpunit"
         ],
         "check-complete": [
             "@php ./bin/phpcs-check-feature-completeness ./PHPCSDebug"
diff --git a/phpunit-bootstrap.php b/phpunit-bootstrap.php
index 9689d19..4ae4de7 100644
--- a/phpunit-bootstrap.php
+++ b/phpunit-bootstrap.php
@@ -17,33 +17,51 @@
     \define('PHP_CODESNIFFER_IN_TESTS', true);
 }
 
+if (\defined('PHP_CODESNIFFER_CBF') === false) {
+    \define('PHP_CODESNIFFER_CBF', false);
+}
+
+if (\defined('PHP_CODESNIFFER_VERBOSITY') === false) {
+    \define('PHP_CODESNIFFER_VERBOSITY', 0);
+}
+
 $ds = \DIRECTORY_SEPARATOR;
 
 /*
  * Load the necessary PHPCS files.
  */
 // Get the PHPCS dir from an environment variable.
-$phpcsDir          = \getenv('PHPCS_DIR');
-$composerPHPCSPath = __DIR__ . $ds . 'vendor' . $ds . 'squizlabs' . $ds . 'php_codesniffer';
-
-if ($phpcsDir === false && \is_dir($composerPHPCSPath)) {
-    // PHPCS installed via Composer.
-    $phpcsDir = $composerPHPCSPath;
-} elseif ($phpcsDir !== false) {
-    /*
-     * PHPCS in a custom directory.
-     * For this to work, the `PHPCS_DIR` needs to be set in a custom `phpunit.xml` file.
-     */
+$phpcsDir = \getenv('PHPCS_DIR');
+
+// Get the PHPCSUtils dir from an environment variable.
+$phpcsUtilsDir = \getenv('PHPCSUTILS_DIR');
+
+// This may be a Composer install.
+if (\is_dir(__DIR__ . $ds . 'vendor')) {
+    $vendorDir = __DIR__ . $ds . 'vendor';
+    if ($phpcsDir === false && \is_dir($vendorDir . $ds . 'squizlabs' . $ds . 'php_codesniffer')) {
+        $phpcsDir = $vendorDir . $ds . 'squizlabs' . $ds . 'php_codesniffer';
+    }
+    if ($phpcsUtilsDir === false && \is_dir($vendorDir . $ds . 'phpcsstandards' . $ds . 'phpcsutils')) {
+        $phpcsUtilsDir = $vendorDir . $ds . 'phpcsstandards' . $ds . 'phpcsutils';
+    }
+}
+
+if ($phpcsDir !== false) {
     $phpcsDir = \realpath($phpcsDir);
 }
 
-// Try and load the PHPCS bootstrap which loads the autoloader and PHPUnit aliases.
-if ($phpcsDir !== false && \is_dir($phpcsDir)) {
-    if (\file_exists($phpcsDir . $ds . 'tests' . $ds . 'bootstrap.php')) {
-        require_once $phpcsDir . $ds . 'tests' . $ds . 'bootstrap.php'; // PHPUnit 6.x+ support as of PHPCS 3.1.0.
-    } elseif (\file_exists($phpcsDir . $ds . 'autoload.php')) {
-        require_once $phpcsDir . $ds . 'autoload.php'; // PHPCS < 3.1.0.
-    }
+if ($phpcsUtilsDir !== false) {
+    $phpcsUtilsDir = \realpath($phpcsUtilsDir);
+}
+
+// Try and load the PHPCS autoloader.
+if ($phpcsDir !== false && \file_exists($phpcsDir . $ds . 'autoload.php')) {
+    // PHPCS 3.x.
+    require_once $phpcsDir . $ds . 'autoload.php';
+
+    // Pre-load the token back-fills to prevent undefined constant notices.
+    require_once $phpcsDir . '/src/Util/Tokens.php';
 } else {
     echo 'Uh oh... can\'t find PHPCS.
 
@@ -55,28 +73,19 @@
     die(1);
 }
 
-/*
- * Set the PHPCS_IGNORE_TEST environment variable to ignore tests from other standards.
- * Ref: https://github.com/squizlabs/PHP_CodeSniffer/pull/1146
- */
-$phpcsDevtoolsStandards = [
-    'PHPCSDebug' => true,
-];
-
-$allStandards   = PHP_CodeSniffer\Util\Standards::getInstalledStandards();
-$allStandards[] = 'Generic';
+// Try and load the PHPCSUtils autoloader.
+if ($phpcsUtilsDir !== false && \file_exists($phpcsUtilsDir . $ds . 'phpcsutils-autoload.php')) {
+    require_once $phpcsUtilsDir . $ds . 'phpcsutils-autoload.php';
+} else {
+    echo 'Uh oh... can\'t find PHPCSUtils.
 
-$standardsToIgnore = [];
-foreach ($allStandards as $standard) {
-    if (isset($phpcsDevtoolsStandards[$standard]) === true) {
-        continue;
-    }
+If you use Composer, please run `composer install`.
+Otherwise, make sure you set a `PHPCSUTILS_DIR` environment variable in your phpunit.xml file
+pointing to the PHPCSUtils directory.
+';
 
-    $standardsToIgnore[] = $standard;
+    die(1);
 }
 
-$standardsToIgnoreString = \implode(',', $standardsToIgnore);
-\putenv("PHPCS_IGNORE_TESTS={$standardsToIgnoreString}");
-
 // Clean up.
-unset($ds, $phpcsDir, $composerPHPCSPath, $allStandards, $standardsToIgnore, $standard, $standardsToIgnoreString);
+unset($ds, $phpcsDir, $phpcsUtilsDir, $vendorDir);

From eeedea0e6f9f67b4a6c8dece61379796ca66bfdf Mon Sep 17 00:00:00 2001
From: jrfnl <jrfnl@users.noreply.github.com>
Date: Tue, 21 Jul 2020 00:05:14 +0200
Subject: [PATCH 03/17] Travis: change from "trusty" to "xenial"

As the "trusty" environment is no longer officially supported by Travis, they decided in their wisdom to silently stop updating the PHP "nightly" image, which makes it next to useless as the last image apparently is from January....

This updates the Travis config to:
* Remove the global `dist` key, which let's the build use the system default, which at this time is `xenial`.
* Sets the distro for low PHP versions explicitly to `trusty`.
* Makes the expected OS explicit (linux).
* Remove redundant `stage` keys.
---
 .travis.yml | 35 ++++++++++++++++++++++-------------
 1 file changed, 22 insertions(+), 13 deletions(-)

diff --git a/.travis.yml b/.travis.yml
index 0db75e2..ee54377 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -1,5 +1,4 @@
-dist: trusty
-
+os: linux
 language: php
 
 ## Cache composer and apt downloads.
@@ -11,10 +10,8 @@ cache:
     # Cache directory for more recent Composer versions.
     - $HOME/.cache/composer/files
 
-# Note: PHP 7.3, 7.4 and nightly are added via "jobs".
+# Note: PHP 5.4, 5.5, 7.3, 7.4 and nightly are added via "jobs".
 php:
-  - 5.4
-  - 5.5
   - 5.6
   - 7.0
   - 7.1
@@ -70,15 +67,14 @@ jobs:
     - stage: quicktest
       php: 7.4
       env: PHPCS_VERSION="dev-master" LINT=1
-    - stage: quicktest
-      php: 7.2
+    - php: 7.2
       env: PHPCS_VERSION="3.1.0"
 
-    - stage: quicktest
-      php: 5.4
+    - php: 5.4
+      dist: trusty
       env: PHPCS_VERSION="dev-master" LINT=1
-    - stage: quicktest
-      php: 5.4
+    - php: 5.4
+      dist: trusty
       env: PHPCS_VERSION="3.1.0"
 
     #### TEST STAGE ####
@@ -95,9 +91,22 @@ jobs:
     - php: 7.4
       env: PHPCS_VERSION="3.5.0"
 
+    # PHP 5.4/5.5 need trusty.
+    - php: 5.5
+      dist: trusty
+      env: PHPCS_VERSION="dev-master" LINT=1
+    - php: 5.5
+      dist: trusty
+      env: PHPCS_VERSION="3.1.0"
+    - php: 5.4
+      dist: trusty
+      env: PHPCS_VERSION="dev-master" LINT=1
+    - php: 5.4
+      dist: trusty
+      env: PHPCS_VERSION="3.1.0"
+
     # Builds against unstable versions which are allowed to fail for now.
-    - stage: test
-      php: 7.4
+    - php: 7.4
       env: PHPCS_VERSION="4.0.x-dev"
     - php: "nightly"
       env: PHPCS_VERSION="dev-master" LINT=1

From bd5d0f075b10ae78f705ae0ef3e6c61540429804 Mon Sep 17 00:00:00 2001
From: jrfnl <jrfnl@users.noreply.github.com>
Date: Thu, 3 Sep 2020 19:16:02 +0200
Subject: [PATCH 04/17] Travis: retry composer install on failure

The builds are failing a little too often for my taste on the below error.
```
[Composer\Downloader\TransportException]
Peer fingerprint did not match
```

I'm prefixing the `composer install` commands now with `travis_retry` in an attempt to get round this problem.

Ref:
* https://docs.travis-ci.com/user/common-build-problems/#timeouts-installing-dependencies
---
 .travis.yml | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/.travis.yml b/.travis.yml
index ee54377..f241aa1 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -134,16 +134,16 @@ before_install:
   - |
     if [[ "${TRAVIS_BUILD_STAGE_NAME^}" != "Sniff" ]]; then
       # Remove the PHPCSDevCS dependency as it has different PHPCS requirements and would block installs.
-      composer remove --dev phpcsstandards/phpcsdevcs --no-update --no-scripts
+      travis_retry composer remove --dev phpcsstandards/phpcsdevcs --no-update --no-scripts
     fi
   - |
     if [[ $PHPCS_VERSION != "n/a" ]]; then
-      composer require --no-update --no-scripts squizlabs/php_codesniffer:${PHPCS_VERSION}
+      travis_retry composer require --no-update --no-scripts squizlabs/php_codesniffer:${PHPCS_VERSION}
     fi
   - |
     if [[ "${TRAVIS_BUILD_STAGE_NAME^}" == "Sniff" ]]; then
       # The sniff stage doesn't run the unit tests, so no need for PHPUnit.
-      composer remove --dev phpunit/phpunit --no-update --no-scripts
+      travis_retry composer remove --dev phpunit/phpunit --no-update --no-scripts
     fi
 
   # --prefer-dist will allow for optimal use of the travis caching ability.
@@ -151,9 +151,9 @@ before_install:
   - |
     if [[ $TRAVIS_PHP_VERSION == "nightly" ]]; then
       # Not all dependencies allow for installing on nightly yet, so ignore platform requirements.
-      composer install --prefer-dist --no-suggest --ignore-platform-reqs
+      travis_retry composer install --prefer-dist --no-suggest --ignore-platform-reqs
     else
-      composer install --prefer-dist --no-suggest
+      travis_retry composer install --prefer-dist --no-suggest
     fi
 
 

From 056ea56bd988cabbd0d17d5650b7a289be9c1ea6 Mon Sep 17 00:00:00 2001
From: jrfnl <jrfnl@users.noreply.github.com>
Date: Thu, 3 Sep 2020 19:17:07 +0200
Subject: [PATCH 05/17] Travis: remove redundant conditions

There are no builds with `PHPCS_VERSION` set to `n/a` at the moment, so we may as well remove the conditions.
---
 .travis.yml | 7 ++-----
 1 file changed, 2 insertions(+), 5 deletions(-)

diff --git a/.travis.yml b/.travis.yml
index f241aa1..eaa6d00 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -136,10 +136,7 @@ before_install:
       # Remove the PHPCSDevCS dependency as it has different PHPCS requirements and would block installs.
       travis_retry composer remove --dev phpcsstandards/phpcsdevcs --no-update --no-scripts
     fi
-  - |
-    if [[ $PHPCS_VERSION != "n/a" ]]; then
-      travis_retry composer require --no-update --no-scripts squizlabs/php_codesniffer:${PHPCS_VERSION}
-    fi
+  - travis_retry composer require --no-update --no-scripts squizlabs/php_codesniffer:${PHPCS_VERSION}
   - |
     if [[ "${TRAVIS_BUILD_STAGE_NAME^}" == "Sniff" ]]; then
       # The sniff stage doesn't run the unit tests, so no need for PHPUnit.
@@ -167,4 +164,4 @@ script:
   - if [[ "$LINT" == "1" ]]; then composer check-complete; fi
 
   # Run the unit tests.
-  - if [[ $PHPCS_VERSION != "n/a" ]]; then composer run-tests; fi
+  - composer run-tests

From 361b04e7fdfc5b7fba73e8b8f69a928aa97c7df5 Mon Sep 17 00:00:00 2001
From: jrfnl <jrfnl@users.noreply.github.com>
Date: Thu, 3 Sep 2020 19:19:06 +0200
Subject: [PATCH 06/17] Travis: move the "Sniff" stage specific install
 instructions to the stage

... to simplify the script a little more and make it clearer what belongs to what stage.
---
 .travis.yml | 28 ++++++++++++++--------------
 1 file changed, 14 insertions(+), 14 deletions(-)

diff --git a/.travis.yml b/.travis.yml
index eaa6d00..0d1531f 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -41,11 +41,21 @@ jobs:
     #### SNIFF STAGE ####
     - stage: sniff
       php: 7.4
-      env: PHPCS_VERSION="dev-master"
       addons:
         apt:
           packages:
             - libxml2-utils
+
+      before_install:
+        - phpenv config-rm xdebug.ini || echo 'No xdebug config.'
+        - export XMLLINT_INDENT="    "
+        # Set up CS check.
+        # - Using PHPCS `master` as an early detection system for bugs upstream.
+        # - The sniff stage doesn't run the unit tests, so no need for PHPUnit.
+        - travis_retry composer remove --dev phpunit/phpunit --no-update --no-scripts
+        - travis_retry composer require --no-update squizlabs/php_codesniffer:"dev-master"
+        - travis_retry composer install --no-interaction
+
       script:
         # Check the code style of the code base.
         - composer check-cs
@@ -124,24 +134,14 @@ before_install:
   # On stable PHPCS versions, allow for PHP deprecation notices.
   # Unit tests don't need to fail on those for stable releases where those issues won't get fixed anymore.
   - |
-    if [[ "${TRAVIS_BUILD_STAGE_NAME^}" != "Sniff" && "$PHPCS_VERSION" != "dev-master" && "$PHPCS_VERSION" != "4.0.x-dev" ]]; then
+    if [[ "$PHPCS_VERSION" != "dev-master" && "$PHPCS_VERSION" != "4.0.x-dev" ]]; then
       echo 'error_reporting = E_ALL & ~E_DEPRECATED' >> ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/travis.ini
     fi
 
-  - export XMLLINT_INDENT="    "
-
   # Set up test environment using Composer.
-  - |
-    if [[ "${TRAVIS_BUILD_STAGE_NAME^}" != "Sniff" ]]; then
-      # Remove the PHPCSDevCS dependency as it has different PHPCS requirements and would block installs.
-      travis_retry composer remove --dev phpcsstandards/phpcsdevcs --no-update --no-scripts
-    fi
   - travis_retry composer require --no-update --no-scripts squizlabs/php_codesniffer:${PHPCS_VERSION}
-  - |
-    if [[ "${TRAVIS_BUILD_STAGE_NAME^}" == "Sniff" ]]; then
-      # The sniff stage doesn't run the unit tests, so no need for PHPUnit.
-      travis_retry composer remove --dev phpunit/phpunit --no-update --no-scripts
-    fi
+  # Remove the PHPCSDevCS dependency as it has different PHPCS requirements and would block installs.
+  - travis_retry composer remove --dev phpcsstandards/phpcsdevcs --no-update --no-scripts
 
   # --prefer-dist will allow for optimal use of the travis caching ability.
   # The Composer PHPCS plugin takes care of setting the installed_paths for PHPCS.

From e4e05a4f309c6dff9b7e421fd0b6ef871379cad9 Mon Sep 17 00:00:00 2001
From: jrfnl <jrfnl@users.noreply.github.com>
Date: Sun, 20 Sep 2020 20:45:25 +0200
Subject: [PATCH 07/17] Debug/TokenList: change the column separator from `::`
 to `|`

---
 PHPCSDebug/Sniffs/Debug/TokenListSniff.php   | 23 ++++++++++----------
 PHPCSDebug/Tests/Debug/TokenListUnitTest.php | 10 ++++-----
 2 files changed, 17 insertions(+), 16 deletions(-)

diff --git a/PHPCSDebug/Sniffs/Debug/TokenListSniff.php b/PHPCSDebug/Sniffs/Debug/TokenListSniff.php
index 635ac45..ddcde74 100644
--- a/PHPCSDebug/Sniffs/Debug/TokenListSniff.php
+++ b/PHPCSDebug/Sniffs/Debug/TokenListSniff.php
@@ -81,14 +81,15 @@ public function process(File $phpcsFile, $stackPtr)
 
         $ptrPadding  = \max(3, \strlen($last));
         $linePadding = \strlen($tokens[$last]['line']);
+        $sep         = ' | ';
 
         echo \PHP_EOL;
         echo \str_pad('Ptr', $ptrPadding, ' ', \STR_PAD_BOTH),
-            ' :: ', \str_pad('Ln', ($linePadding + 1), ' ', \STR_PAD_BOTH),
-            ' :: ', \str_pad('Col', 4, ' ', \STR_PAD_BOTH),
-            ' :: ', 'Cond',
-            ' :: ', \str_pad('Token Type', 26), // Longest token type name is 26 chars.
-            ' :: [len]: Content', \PHP_EOL;
+            $sep, \str_pad('Ln', ($linePadding + 1), ' ', \STR_PAD_BOTH),
+            $sep, \str_pad('Col', 4, ' ', \STR_PAD_BOTH),
+            $sep, 'Cond',
+            $sep, \str_pad('Token Type', 26), // Longest token type name is 26 chars.
+            $sep, '[len]: Content', \PHP_EOL;
 
         echo \str_repeat('-', ($ptrPadding + $linePadding + 35 + 16 + 18)), \PHP_EOL;
 
@@ -111,18 +112,18 @@ public function process(File $phpcsFile, $stackPtr)
                     $content = \str_replace("\t", '\t', $content);
                 }
                 if (isset($token['orig_content'])) {
-                    $content .= ' :: Orig: ' . \str_replace("\t", '\t', $token['orig_content']);
+                    $content .= $sep . 'Orig: ' . \str_replace("\t", '\t', $token['orig_content']);
                 }
             }
 
             $conditionCount = \count($token['conditions']);
 
             echo \str_pad($ptr, $ptrPadding, ' ', \STR_PAD_LEFT),
-                ' :: L', \str_pad($token['line'], $linePadding, '0', \STR_PAD_LEFT),
-                ' :: C', \str_pad($token['column'], 3, ' ', \STR_PAD_LEFT),
-                ' :: CC', \str_pad($conditionCount, 2, ' ', \STR_PAD_LEFT),
-                ' :: ', \str_pad($token['type'], 26), // Longest token type name is 26 chars.
-                ' :: [', $token['length'], ']: ', $content, \PHP_EOL;
+                $sep, 'L', \str_pad($token['line'], $linePadding, '0', \STR_PAD_LEFT),
+                $sep, 'C', \str_pad($token['column'], 3, ' ', \STR_PAD_LEFT),
+                $sep, 'CC', \str_pad($conditionCount, 2, ' ', \STR_PAD_LEFT),
+                $sep, \str_pad($token['type'], 26), // Longest token type name is 26 chars.
+                $sep, '[', $token['length'], ']: ', $content, \PHP_EOL;
         }
 
         // Only do this once per file.
diff --git a/PHPCSDebug/Tests/Debug/TokenListUnitTest.php b/PHPCSDebug/Tests/Debug/TokenListUnitTest.php
index d855f32..ead8f0d 100644
--- a/PHPCSDebug/Tests/Debug/TokenListUnitTest.php
+++ b/PHPCSDebug/Tests/Debug/TokenListUnitTest.php
@@ -45,12 +45,12 @@ public function testOutput()
         $this->assertNotEmpty($output);
 
         $expected  = "\n";
-        $expected .= 'Ptr :: Ln :: Col  :: Cond :: Token Type                 :: [len]: Content' . "\n";
+        $expected .= 'Ptr | Ln | Col  | Cond | Token Type                 | [len]: Content' . "\n";
         $expected .= '-------------------------------------------------------------------------' . "\n";
-        $expected .= '  0 :: L1 :: C  1 :: CC 0 :: T_OPEN_TAG                 :: [5]: <?php' . "\n\n";
-        $expected .= '  1 :: L2 :: C  1 :: CC 0 :: T_WHITESPACE               :: [0]: ' . "\n\n";
-        $expected .= '  2 :: L3 :: C  1 :: CC 0 :: T_FUNCTION                 :: [8]: function' . "\n";
-        $expected .= '  3 :: L3 :: C  9 :: CC 0 :: T_WHITESPACE               :: [0]: ' . "\n\n";
+        $expected .= '  0 | L1 | C  1 | CC 0 | T_OPEN_TAG                 | [5]: <?php' . "\n\n";
+        $expected .= '  1 | L2 | C  1 | CC 0 | T_WHITESPACE               | [0]: ' . "\n\n";
+        $expected .= '  2 | L3 | C  1 | CC 0 | T_FUNCTION                 | [8]: function' . "\n";
+        $expected .= '  3 | L3 | C  9 | CC 0 | T_WHITESPACE               | [0]: ' . "\n\n";
 
         $this->assertSame($expected, $output);
     }

From 379f8cdf5b024fb81a16f53c9f955fbeb4f7bf6e Mon Sep 17 00:00:00 2001
From: jrfnl <jrfnl@users.noreply.github.com>
Date: Sun, 20 Sep 2020 20:53:57 +0200
Subject: [PATCH 08/17] Debug/TokenList: small simplifications

* The `level` index already contains the condition count, so no need for doing a `count()` within the sniff.
* No need to use `str_pad()` for a title with fixed length.
---
 PHPCSDebug/Sniffs/Debug/TokenListSniff.php | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

diff --git a/PHPCSDebug/Sniffs/Debug/TokenListSniff.php b/PHPCSDebug/Sniffs/Debug/TokenListSniff.php
index ddcde74..ffe51db 100644
--- a/PHPCSDebug/Sniffs/Debug/TokenListSniff.php
+++ b/PHPCSDebug/Sniffs/Debug/TokenListSniff.php
@@ -86,7 +86,7 @@ public function process(File $phpcsFile, $stackPtr)
         echo \PHP_EOL;
         echo \str_pad('Ptr', $ptrPadding, ' ', \STR_PAD_BOTH),
             $sep, \str_pad('Ln', ($linePadding + 1), ' ', \STR_PAD_BOTH),
-            $sep, \str_pad('Col', 4, ' ', \STR_PAD_BOTH),
+            $sep, 'Col ',
             $sep, 'Cond',
             $sep, \str_pad('Token Type', 26), // Longest token type name is 26 chars.
             $sep, '[len]: Content', \PHP_EOL;
@@ -116,12 +116,10 @@ public function process(File $phpcsFile, $stackPtr)
                 }
             }
 
-            $conditionCount = \count($token['conditions']);
-
             echo \str_pad($ptr, $ptrPadding, ' ', \STR_PAD_LEFT),
                 $sep, 'L', \str_pad($token['line'], $linePadding, '0', \STR_PAD_LEFT),
                 $sep, 'C', \str_pad($token['column'], 3, ' ', \STR_PAD_LEFT),
-                $sep, 'CC', \str_pad($conditionCount, 2, ' ', \STR_PAD_LEFT),
+                $sep, 'CC', \str_pad($token['level'], 2, ' ', \STR_PAD_LEFT),
                 $sep, \str_pad($token['type'], 26), // Longest token type name is 26 chars.
                 $sep, '[', $token['length'], ']: ', $content, \PHP_EOL;
         }

From 8ae192ea9dd03aa57eea91f4ee4dd1711f344cf7 Mon Sep 17 00:00:00 2001
From: jrfnl <jrfnl@users.noreply.github.com>
Date: Sun, 20 Sep 2020 22:08:53 +0200
Subject: [PATCH 09/17] Debug/TokenList: add column showing nr of nested
 parentheses

This is based on a count of the `nested_parenthesis` index.

Includes adjusted unit tests.
---
 PHPCSDebug/Sniffs/Debug/TokenListSniff.php   |  7 +++++++
 PHPCSDebug/Tests/Debug/TokenListUnitTest.php | 10 +++++-----
 2 files changed, 12 insertions(+), 5 deletions(-)

diff --git a/PHPCSDebug/Sniffs/Debug/TokenListSniff.php b/PHPCSDebug/Sniffs/Debug/TokenListSniff.php
index ffe51db..f19bfba 100644
--- a/PHPCSDebug/Sniffs/Debug/TokenListSniff.php
+++ b/PHPCSDebug/Sniffs/Debug/TokenListSniff.php
@@ -88,6 +88,7 @@ public function process(File $phpcsFile, $stackPtr)
             $sep, \str_pad('Ln', ($linePadding + 1), ' ', \STR_PAD_BOTH),
             $sep, 'Col ',
             $sep, 'Cond',
+            $sep, '( #)',
             $sep, \str_pad('Token Type', 26), // Longest token type name is 26 chars.
             $sep, '[len]: Content', \PHP_EOL;
 
@@ -116,10 +117,16 @@ public function process(File $phpcsFile, $stackPtr)
                 }
             }
 
+            $parenthesesCount = 0;
+            if (isset($token['nested_parenthesis'])) {
+                $parenthesesCount = \count($token['nested_parenthesis']);
+            }
+
             echo \str_pad($ptr, $ptrPadding, ' ', \STR_PAD_LEFT),
                 $sep, 'L', \str_pad($token['line'], $linePadding, '0', \STR_PAD_LEFT),
                 $sep, 'C', \str_pad($token['column'], 3, ' ', \STR_PAD_LEFT),
                 $sep, 'CC', \str_pad($token['level'], 2, ' ', \STR_PAD_LEFT),
+                $sep, '(', \str_pad($parenthesesCount, 2, ' ', \STR_PAD_LEFT), ')',
                 $sep, \str_pad($token['type'], 26), // Longest token type name is 26 chars.
                 $sep, '[', $token['length'], ']: ', $content, \PHP_EOL;
         }
diff --git a/PHPCSDebug/Tests/Debug/TokenListUnitTest.php b/PHPCSDebug/Tests/Debug/TokenListUnitTest.php
index ead8f0d..7f73feb 100644
--- a/PHPCSDebug/Tests/Debug/TokenListUnitTest.php
+++ b/PHPCSDebug/Tests/Debug/TokenListUnitTest.php
@@ -45,12 +45,12 @@ public function testOutput()
         $this->assertNotEmpty($output);
 
         $expected  = "\n";
-        $expected .= 'Ptr | Ln | Col  | Cond | Token Type                 | [len]: Content' . "\n";
+        $expected .= 'Ptr | Ln | Col  | Cond | ( #) | Token Type                 | [len]: Content' . "\n";
         $expected .= '-------------------------------------------------------------------------' . "\n";
-        $expected .= '  0 | L1 | C  1 | CC 0 | T_OPEN_TAG                 | [5]: <?php' . "\n\n";
-        $expected .= '  1 | L2 | C  1 | CC 0 | T_WHITESPACE               | [0]: ' . "\n\n";
-        $expected .= '  2 | L3 | C  1 | CC 0 | T_FUNCTION                 | [8]: function' . "\n";
-        $expected .= '  3 | L3 | C  9 | CC 0 | T_WHITESPACE               | [0]: ' . "\n\n";
+        $expected .= '  0 | L1 | C  1 | CC 0 | ( 0) | T_OPEN_TAG                 | [5]: <?php' . "\n\n";
+        $expected .= '  1 | L2 | C  1 | CC 0 | ( 0) | T_WHITESPACE               | [0]: ' . "\n\n";
+        $expected .= '  2 | L3 | C  1 | CC 0 | ( 0) | T_FUNCTION                 | [8]: function' . "\n";
+        $expected .= '  3 | L3 | C  9 | CC 0 | ( 0) | T_WHITESPACE               | [0]: ' . "\n\n";
 
         $this->assertSame($expected, $output);
     }

From 29c5843b35d0ab74eb397bc7e954328ea4232ec9 Mon Sep 17 00:00:00 2001
From: jrfnl <jrfnl@users.noreply.github.com>
Date: Sat, 3 Oct 2020 03:23:10 +0200
Subject: [PATCH 10/17] QA: minor tweak

On failure, `substr()` can return `false` or an empty string and as of PHP 8.0, that will be reduced to just an empty string.

This simple tweak harden the code just in case `false` would be returned.
---
 Scripts/CheckSniffCompleteness.php | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Scripts/CheckSniffCompleteness.php b/Scripts/CheckSniffCompleteness.php
index 36e0684..e77b9bd 100644
--- a/Scripts/CheckSniffCompleteness.php
+++ b/Scripts/CheckSniffCompleteness.php
@@ -258,7 +258,7 @@ protected function processCliCommand()
         foreach ($args as $arg) {
             if (\strpos($arg, '--exclude=') === 0) {
                 $exclude = \substr($arg, 10);
-                if ($exclude === '') {
+                if (empty($exclude)) {
                     $this->excludedDirs = [];
                     continue;
                 }

From 7d29e66626991feb503953f8333b2a64e8e74333 Mon Sep 17 00:00:00 2001
From: jrfnl <jrfnl@users.noreply.github.com>
Date: Fri, 4 Dec 2020 08:35:08 +0100
Subject: [PATCH 11/17] Travis: add build against PHP 8.0

PHP 8.0 has been branched off two months ago, so `nightly` is now PHP 8.1 and in the mean time PHP 8.0 was released last week.

As of today, there is a PHP 8.0 image available on Travis.

This PR adds two new builds against PHP 8.0 to the matrix and, as PHP 8.0 has been released, these builds are not allowed to fail.
---
 .travis.yml | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/.travis.yml b/.travis.yml
index 0d1531f..ab26b48 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -100,6 +100,11 @@ jobs:
     # PHPCS is only compatible with PHP 7.4 as of version 3.5.0.
     - php: 7.4
       env: PHPCS_VERSION="3.5.0"
+    - php: 8.0
+      env: PHPCS_VERSION="dev-master" LINT=1
+    # PHPCS is only compatible with PHP 8.0 as of version 3.5.7.
+    - php: 8.0
+      env: PHPCS_VERSION="3.5.7"
 
     # PHP 5.4/5.5 need trusty.
     - php: 5.5
@@ -146,8 +151,8 @@ before_install:
   # --prefer-dist will allow for optimal use of the travis caching ability.
   # The Composer PHPCS plugin takes care of setting the installed_paths for PHPCS.
   - |
-    if [[ $TRAVIS_PHP_VERSION == "nightly" ]]; then
-      # Not all dependencies allow for installing on nightly yet, so ignore platform requirements.
+    if [[ $TRAVIS_PHP_VERSION == "nightly" || $TRAVIS_PHP_VERSION == "8.0" ]]; then
+      # Not all dependencies allow for installing on PHP 8.0+, so ignore platform requirements.
       travis_retry composer install --prefer-dist --no-suggest --ignore-platform-reqs
     else
       travis_retry composer install --prefer-dist --no-suggest

From 89d563aede6895fa073597c8b1dd79ba30bc2043 Mon Sep 17 00:00:00 2001
From: jrfnl <jrfnl@users.noreply.github.com>
Date: Sun, 20 Dec 2020 09:57:26 +0100
Subject: [PATCH 12/17] CI: switch to GitHub Actions - step 1: sniff stage

This commit:
* Adds a GH Actions workflow for the CI checks which were previously run on Travis in the `sniff` stage.
    While these aren't 100% CS (= code style) checks, for the badge and workflow display, `CS` still seemed the most descriptive name.
*  Removes that part of the `.travis.yml` configuration.
* Adds a "Build Status" badge in the Readme to use the results from this particular GH Actions runs.

Notes:
Builds will run on all pushes and on pull requests, with the exception  of those just modifying files which are irrelevant to this workflow.
---
 .github/workflows/cs.yml | 66 ++++++++++++++++++++++++++++++++++++++++
 .travis.yml              | 34 ---------------------
 README.md                |  1 +
 3 files changed, 67 insertions(+), 34 deletions(-)
 create mode 100644 .github/workflows/cs.yml

diff --git a/.github/workflows/cs.yml b/.github/workflows/cs.yml
new file mode 100644
index 0000000..31b658c
--- /dev/null
+++ b/.github/workflows/cs.yml
@@ -0,0 +1,66 @@
+name: CS
+
+on:
+  # Run on all pushes and on all pull requests.
+  # Prevent the build from running when there are only irrelevant changes.
+  push:
+    paths-ignore:
+      - '**.md'
+  pull_request:
+    paths-ignore:
+      - '**.md'
+
+jobs:
+  checkcs:
+    name: 'Basic CS and QA checks'
+    runs-on: ubuntu-latest
+
+    env:
+      XMLLINT_INDENT: '    '
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Install PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '7.4'
+          coverage: none
+
+      - name: 'Composer: adjust dependencies'
+        run: |
+          # The sniff stage doesn't run the unit tests, so no need for PHPUnit.
+          composer remove --no-update --dev phpunit/phpunit --no-scripts
+          # Using PHPCS `master` as an early detection system for bugs upstream.
+          composer require --no-update squizlabs/php_codesniffer:"dev-master"
+
+      # Install dependencies and handle caching in one go.
+      # @link https://github.com/marketplace/actions/install-composer-dependencies
+      - name: Install Composer dependencies
+        uses: "ramsey/composer-install@v1"
+
+      - name: Install xmllint
+        run: sudo apt-get install --no-install-recommends -y libxml2-utils
+
+      # Show XML violations inline in the file diff.
+      # @link https://github.com/marketplace/actions/xmllint-problem-matcher
+      - uses: korelstar/xmllint-problem-matcher@v1
+
+      # Validate the XML file.
+      # @link http://xmlsoft.org/xmllint.html
+      - name: Validate ruleset against schema
+        run: xmllint --noout --schema vendor/squizlabs/php_codesniffer/phpcs.xsd PHPCSDebug/ruleset.xml
+
+      # Check the code-style consistency of the XML file.
+      - name: Check XML code style
+        run: diff -B ./PHPCSDebug/ruleset.xml <(xmllint --format "./PHPCSDebug/ruleset.xml")
+
+      # Check the code-style consistency of the PHP files.
+      - name: Check PHP code style
+        run: composer check-cs
+
+      # Validate the composer.json file.
+      # @link https://getcomposer.org/doc/03-cli.md#validate
+      - name: Validate Composer installation
+        run: composer validate --no-check-all --strict
diff --git a/.travis.yml b/.travis.yml
index ab26b48..9310d7d 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -29,7 +29,6 @@ env:
 # Note: for pull requests, "develop" is the base branch name.
 # See: https://docs.travis-ci.com/user/conditions-v1
 stages:
-  - name: sniff
   - name: quicktest
     if: type = push AND branch NOT IN (stable, develop)
   - name: test
@@ -38,39 +37,6 @@ stages:
 jobs:
   fast_finish: true
   include:
-    #### SNIFF STAGE ####
-    - stage: sniff
-      php: 7.4
-      addons:
-        apt:
-          packages:
-            - libxml2-utils
-
-      before_install:
-        - phpenv config-rm xdebug.ini || echo 'No xdebug config.'
-        - export XMLLINT_INDENT="    "
-        # Set up CS check.
-        # - Using PHPCS `master` as an early detection system for bugs upstream.
-        # - The sniff stage doesn't run the unit tests, so no need for PHPUnit.
-        - travis_retry composer remove --dev phpunit/phpunit --no-update --no-scripts
-        - travis_retry composer require --no-update squizlabs/php_codesniffer:"dev-master"
-        - travis_retry composer install --no-interaction
-
-      script:
-        # Check the code style of the code base.
-        - composer check-cs
-
-        # Validate the xml file.
-        # @link http://xmlsoft.org/xmllint.html
-        - xmllint --noout --schema ./vendor/squizlabs/php_codesniffer/phpcs.xsd ./PHPCSDebug/ruleset.xml
-
-        # Check the code-style consistency of the xml files.
-        - diff -B ./PHPCSDebug/ruleset.xml <(xmllint --format "./PHPCSDebug/ruleset.xml")
-
-        # Validate the composer.json file.
-        # @link https://getcomposer.org/doc/03-cli.md#validate
-        - composer validate --no-check-all --strict
-
     #### QUICK TEST STAGE ####
     # This is a much quicker test which only runs the unit tests and linting against the low/high
     # supported PHP/PHPCS combinations.
diff --git a/README.md b/README.md
index 65f19ee..5129c4d 100644
--- a/README.md
+++ b/README.md
@@ -10,6 +10,7 @@ PHPCSDevTools for developers of PHP_CodeSniffer sniffs
 [![Last Commit to Unstable](https://img.shields.io/github/last-commit/PHPCSStandards/PHPCSDevTools/develop.svg)](https://github.com/PHPCSStandards/PHPCSDevTools/commits/develop)
 
 [![Minimum PHP Version](https://img.shields.io/packagist/php-v/phpcsstandards/phpcsdevtools.svg?maxAge=3600)](https://packagist.org/packages/phpcsstandards/phpcsdevtools)
+[![Build Status CS](https://github.com/PHPCSStandards/PHPCSDevTools/workflows/CS/badge.svg?branch=develop)](https://github.com/PHPCSStandards/PHPCSDevTools/actions)
 [![Tested on PHP 5.4 to nightly](https://img.shields.io/badge/tested%20on-PHP%205.4%20|%205.5%20|%205.6%20|%207.0%20|%207.1%20|%207.2%20|%207.3%20|%207.4%20|%20nightly-brightgreen.svg?maxAge=2419200)](https://travis-ci.com/PHPCSStandards/PHPCSDevTools)
 
 [![License: LGPLv3](https://poser.pugx.org/phpcsstandards/phpcsdevtools/license)](https://github.com/PHPCSStandards/PHPCSDevTools/blob/stable/LICENSE)

From 89bb1c3b02f7e9155613880bdeb5e45481cdf456 Mon Sep 17 00:00:00 2001
From: jrfnl <jrfnl@users.noreply.github.com>
Date: Sun, 20 Dec 2020 10:12:57 +0100
Subject: [PATCH 13/17] CI: switch to GitHub Actions - step 2: quick test stage

This commit:
* Adds a GH Actions workflow for the CI checks which were previously run on Travis in the `quicktest` stage.
* Removes that part of the `.travis.yml` configuration.

Notes:
1. Previously, this "stage" would run on all `push` events, except when merging to `master` or `develop`.
    The current set-up still does so, with one exception: pushes to `develop` will now use this quicktest instead of the full test.
    `develop` is a protected branch anyhow, so all merges will already have had the full test run in the pull request.
    For merges to `master`, the full Test will still be used as that will generally mean we're getting ready to tag a release and some extra safety checking before a release is not a bad thing.
2. This also updates the "high" PHP version for the "quicktest" against PHPCS `dev-master` from PHP 7.4 to PHP 8.0 by using `latest` which translates to "latest stable PHP release".
---
 .github/workflows/quicktest.yml | 80 +++++++++++++++++++++++++++++++++
 .travis.yml                     | 18 --------
 2 files changed, 80 insertions(+), 18 deletions(-)
 create mode 100644 .github/workflows/quicktest.yml

diff --git a/.github/workflows/quicktest.yml b/.github/workflows/quicktest.yml
new file mode 100644
index 0000000..97e2f1f
--- /dev/null
+++ b/.github/workflows/quicktest.yml
@@ -0,0 +1,80 @@
+name: Quicktest
+
+on:
+  # Run on pushes, including merges, to all branches except `master`.
+  push:
+    branches-ignore:
+      - master
+    paths-ignore:
+      - '**.md'
+
+jobs:
+  #### QUICK TEST STAGE ####
+  # This is a much quicker test which only runs the unit tests and linting against the low/high
+  # supported PHP/PHPCS combinations.
+  quicktest:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        php: ['5.4', 'latest']
+        phpcs_version: ['dev-master']
+        lint: [true]
+
+        include:
+          - php: '7.2'
+            phpcs_version: '3.1.0'
+            lint: false
+          - php: '5.4'
+            phpcs_version: '3.1.0'
+            lint: false
+
+    name: "QTest${{ matrix.lint && ' + Lint' || '' }}: PHP ${{ matrix.php }} - PHPCS ${{ matrix.phpcs_version }}"
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      # On stable PHPCS versions, allow for PHP deprecation notices.
+      # Unit tests don't need to fail on those for stable releases where those issues won't get fixed anymore.
+      - name: Setup ini config
+        id: set_ini
+        run: |
+          if [ "${{ matrix.phpcs_version }}" != "dev-master" ]; then
+            echo '::set-output name=PHP_INI::error_reporting=E_ALL & ~E_DEPRECATED'
+          else
+            echo '::set-output name=PHP_INI::error_reporting=E_ALL'
+          fi
+
+      - name: Install PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          ini-values: ${{ steps.set_ini.outputs.PHP_INI }}
+          coverage: none
+
+      - name: 'Composer: adjust dependencies'
+        run: |
+          # Set the PHPCS version to be used in the tests.
+          composer require --no-update squizlabs/php_codesniffer:"${{ matrix.phpcs_version }}" --no-scripts
+          # Remove the PHPCSDevCS dependency as it has different PHPCS requirements and would block installs.
+          composer remove --no-update --dev phpcsstandards/phpcsdevcs --no-scripts
+
+      # Install dependencies and handle caching in one go.
+      # @link https://github.com/marketplace/actions/install-composer-dependencies
+      - name: Install Composer dependencies
+        uses: "ramsey/composer-install@v1"
+
+      - name: Lint against parse errors
+        if: ${{ matrix.lint }}
+        run: composer lint
+
+      # Check that any sniffs available are feature complete.
+      # This also acts as an integration test for the feature completeness script,
+      # which is why it is run against various PHP versions and not in the "Sniff" stage.
+      - name: Check for feature completeness
+        if: ${{ matrix.lint }}
+        run: composer check-complete
+
+      - name: Run the unit tests
+        run: composer run-tests
diff --git a/.travis.yml b/.travis.yml
index 9310d7d..b794cee 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -29,30 +29,12 @@ env:
 # Note: for pull requests, "develop" is the base branch name.
 # See: https://docs.travis-ci.com/user/conditions-v1
 stages:
-  - name: quicktest
-    if: type = push AND branch NOT IN (stable, develop)
   - name: test
     if: branch IN (stable, develop)
 
 jobs:
   fast_finish: true
   include:
-    #### QUICK TEST STAGE ####
-    # This is a much quicker test which only runs the unit tests and linting against the low/high
-    # supported PHP/PHPCS combinations.
-    - stage: quicktest
-      php: 7.4
-      env: PHPCS_VERSION="dev-master" LINT=1
-    - php: 7.2
-      env: PHPCS_VERSION="3.1.0"
-
-    - php: 5.4
-      dist: trusty
-      env: PHPCS_VERSION="dev-master" LINT=1
-    - php: 5.4
-      dist: trusty
-      env: PHPCS_VERSION="3.1.0"
-
     #### TEST STAGE ####
     # Additional builds to prevent issues with PHPCS versions incompatible with certain PHP versions.
     - stage: test

From 764203a4754601d71dccd81ce651a521db55f377 Mon Sep 17 00:00:00 2001
From: jrfnl <jrfnl@users.noreply.github.com>
Date: Sun, 20 Dec 2020 10:34:35 +0100
Subject: [PATCH 14/17] CI: switch to GitHub Actions - step 3: test and
 coverage stage

This commit:
* Adds a GH Actions workflow for the CI checks which were previously run on Travis in the `test` stage.
* Removes the, now redundant, `.travis.yml` configuration.
* Updates the `.gitattributes` file.
* Adds a "Build Status" badge in the Readme to use the results from the GH `Test` Actions runs and removes the old badges.
* Updates the "Tested on" badge.

Notes:
1. Previously, this "stage" would run on all `pull requests` events.
    The current set-up still does so, with one addition: pushes to `master` (merges) will now also use this workflow instead of the quicktest.
    This replaces the full run on tagging a release, meaning that thing will essentially be the same.
2. As there are a couple of jobs which are "allowed to fail" (`experimental` = true), the build status will unfortunately show as "failed", even though all non-experimental jobs have succeeded.
     This is a known issue in GHA: https://github.com/actions/toolkit/issues/399
---
 .gitattributes             |   1 -
 .github/workflows/test.yml | 120 +++++++++++++++++++++++++++++++++++++
 .travis.yml                | 120 -------------------------------------
 README.md                  |   5 +-
 4 files changed, 122 insertions(+), 124 deletions(-)
 create mode 100644 .github/workflows/test.yml
 delete mode 100644 .travis.yml

diff --git a/.gitattributes b/.gitattributes
index f9118ff..c317e82 100644
--- a/.gitattributes
+++ b/.gitattributes
@@ -7,7 +7,6 @@
 #
 /.gitattributes export-ignore
 /.gitignore export-ignore
-/.travis.yml export-ignore
 /phpcs.xml.dist export-ignore
 /phpunit.xml.dist export-ignore
 /phpunit-bootstrap.php export-ignore
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
new file mode 100644
index 0000000..4b4e0bf
--- /dev/null
+++ b/.github/workflows/test.yml
@@ -0,0 +1,120 @@
+name: Test
+
+on:
+  # Run on pushes to `master` and on all pull requests.
+  push:
+    branches:
+      - master
+  pull_request:
+    paths-ignore:
+      - '**.md'
+
+jobs:
+  #### TEST STAGE ####
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      # Keys:
+      # - experimental: Whether the build is "allowed to fail".
+      matrix:
+        # IMPORTANT: test runs shouldn't fail because of PHPCS being incompatible with a PHP version.
+        # - PHPCS will run without errors on PHP 5.4 - 7.2 on any version.
+        # - PHP 7.3 needs PHPCS 3.3.1+ to run without errors.
+        # - PHP 7.4 needs PHPCS 3.5.0+ to run without errors.
+        # - PHP 8.0 needs PHPCS 3.5.7+ to run without errors.
+        php: ['5.4', '5.5', '5.6', '7.0', '7.1', '7.2']
+        phpcs_version: ['3.1.0', 'dev-master']
+        experimental: [false]
+
+        include:
+          # Complete the matrix, while preventing issues with PHPCS versions incompatible with certain PHP versions.
+          - php: '8.0'
+            phpcs_version: 'dev-master'
+            experimental: false
+          - php: '8.0'
+            phpcs_version: '3.5.7'
+            experimental: false
+
+          - php: '7.4'
+            phpcs_version: 'dev-master'
+            experimental: false
+          - php: '7.4'
+            phpcs_version: '3.5.0'
+            experimental: false
+
+          - php: '7.3'
+            phpcs_version: 'dev-master'
+            experimental: false
+          - php: '7.3'
+            phpcs_version: '3.3.1'
+            experimental: false
+
+          # Experimental builds. These are allowed to fail.
+          - php: '7.4'
+            phpcs_version: '4.0.x-dev'
+            experimental: true
+
+          - php: '8.1' # Nightly.
+            phpcs_version: 'dev-master'
+            experimental: true
+
+    name: "Test${{ matrix.phpcs_version == 'dev-master' && ' + Lint' || '' }}: PHP ${{ matrix.php }} - PHPCS ${{ matrix.phpcs_version }}"
+
+    continue-on-error: ${{ matrix.experimental }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Setup ini config
+        id: set_ini
+        run: |
+          # On stable PHPCS versions, allow for PHP deprecation notices.
+          # Unit tests don't need to fail on those for stable releases where those issues won't get fixed anymore.
+          if [[ "${{ matrix.phpcs_version }}" != "dev-master" && "${{ matrix.phpcs_version }}" != "4.0.x-dev" ]]; then
+            echo '::set-output name=PHP_INI::error_reporting=E_ALL & ~E_DEPRECATED'
+          else
+            echo '::set-output name=PHP_INI::error_reporting=E_ALL'
+          fi
+
+      - name: Install PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          ini-values: ${{ steps.set_ini.outputs.PHP_INI }}
+          coverage: none
+
+      - name: 'Composer: adjust dependencies'
+        run: |
+          # Set the PHPCS version to be used in the tests.
+          composer require --no-update squizlabs/php_codesniffer:"${{ matrix.phpcs_version }}" --no-scripts
+          # Remove the PHPCSDevCS dependency as it has different PHPCS requirements and would block installs.
+          composer remove --no-update --dev phpcsstandards/phpcsdevcs --no-scripts
+
+      # Install dependencies and handle caching in one go.
+      # @link https://github.com/marketplace/actions/install-composer-dependencies
+      - name: Install Composer dependencies - normal
+        if: ${{ matrix.php < 8.1 }}
+        uses: "ramsey/composer-install@v1"
+
+      # For PHP "nightly", we need to install with ignore platform reqs as not all dependencies allow installation.
+      - name: Install Composer dependencies - with ignore platform
+        if: ${{ matrix.php >= 8.1 }}
+        uses: "ramsey/composer-install@v1"
+        with:
+          composer-options: --ignore-platform-reqs
+
+      - name: Lint against parse errors
+        if: matrix.phpcs_version == 'dev-master'
+        run: composer lint
+
+      # Check that any sniffs available are feature complete.
+      # This also acts as an integration test for the feature completeness script,
+      # which is why it is run against various PHP versions and not in the "Sniff" stage.
+      - name: Check for feature completeness
+        if: matrix.phpcs_version == 'dev-master'
+        run: composer check-complete
+
+      - name: Run the unit tests
+        run: composer run-tests
diff --git a/.travis.yml b/.travis.yml
deleted file mode 100644
index b794cee..0000000
--- a/.travis.yml
+++ /dev/null
@@ -1,120 +0,0 @@
-os: linux
-language: php
-
-## Cache composer and apt downloads.
-cache:
-  apt: true
-  directories:
-    # Cache directory for older Composer versions.
-    - $HOME/.composer/cache/files
-    # Cache directory for more recent Composer versions.
-    - $HOME/.cache/composer/files
-
-# Note: PHP 5.4, 5.5, 7.3, 7.4 and nightly are added via "jobs".
-php:
-  - 5.6
-  - 7.0
-  - 7.1
-  - 7.2
-
-env:
-  # PHPCS `master`
-  - PHPCS_VERSION="dev-master" LINT=1
-  # Lowest supported PHPCS version.
-  - PHPCS_VERSION="3.1.0"
-
-# Define the stages used.
-# For non-PRs, only the sniff and quicktest stages are run.
-# For pull requests and merges, the full script is run (skipping quicktest).
-# Note: for pull requests, "develop" is the base branch name.
-# See: https://docs.travis-ci.com/user/conditions-v1
-stages:
-  - name: test
-    if: branch IN (stable, develop)
-
-jobs:
-  fast_finish: true
-  include:
-    #### TEST STAGE ####
-    # Additional builds to prevent issues with PHPCS versions incompatible with certain PHP versions.
-    - stage: test
-      php: 7.3
-      env: PHPCS_VERSION="dev-master" LINT=1
-    # PHPCS is only compatible with PHP 7.3 as of version 3.3.1.
-    - php: 7.3
-      env: PHPCS_VERSION="3.3.1"
-    - php: 7.4
-      env: PHPCS_VERSION="dev-master"
-    # PHPCS is only compatible with PHP 7.4 as of version 3.5.0.
-    - php: 7.4
-      env: PHPCS_VERSION="3.5.0"
-    - php: 8.0
-      env: PHPCS_VERSION="dev-master" LINT=1
-    # PHPCS is only compatible with PHP 8.0 as of version 3.5.7.
-    - php: 8.0
-      env: PHPCS_VERSION="3.5.7"
-
-    # PHP 5.4/5.5 need trusty.
-    - php: 5.5
-      dist: trusty
-      env: PHPCS_VERSION="dev-master" LINT=1
-    - php: 5.5
-      dist: trusty
-      env: PHPCS_VERSION="3.1.0"
-    - php: 5.4
-      dist: trusty
-      env: PHPCS_VERSION="dev-master" LINT=1
-    - php: 5.4
-      dist: trusty
-      env: PHPCS_VERSION="3.1.0"
-
-    # Builds against unstable versions which are allowed to fail for now.
-    - php: 7.4
-      env: PHPCS_VERSION="4.0.x-dev"
-    - php: "nightly"
-      env: PHPCS_VERSION="dev-master" LINT=1
-
-  allow_failures:
-    # Allow failures for unstable builds.
-    - php: "nightly"
-    - env: PHPCS_VERSION="4.0.x-dev"
-
-
-before_install:
-  # Speed up build time by disabling Xdebug when its not needed.
-  - phpenv config-rm xdebug.ini || echo 'No xdebug config.'
-
-  # On stable PHPCS versions, allow for PHP deprecation notices.
-  # Unit tests don't need to fail on those for stable releases where those issues won't get fixed anymore.
-  - |
-    if [[ "$PHPCS_VERSION" != "dev-master" && "$PHPCS_VERSION" != "4.0.x-dev" ]]; then
-      echo 'error_reporting = E_ALL & ~E_DEPRECATED' >> ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/travis.ini
-    fi
-
-  # Set up test environment using Composer.
-  - travis_retry composer require --no-update --no-scripts squizlabs/php_codesniffer:${PHPCS_VERSION}
-  # Remove the PHPCSDevCS dependency as it has different PHPCS requirements and would block installs.
-  - travis_retry composer remove --dev phpcsstandards/phpcsdevcs --no-update --no-scripts
-
-  # --prefer-dist will allow for optimal use of the travis caching ability.
-  # The Composer PHPCS plugin takes care of setting the installed_paths for PHPCS.
-  - |
-    if [[ $TRAVIS_PHP_VERSION == "nightly" || $TRAVIS_PHP_VERSION == "8.0" ]]; then
-      # Not all dependencies allow for installing on PHP 8.0+, so ignore platform requirements.
-      travis_retry composer install --prefer-dist --no-suggest --ignore-platform-reqs
-    else
-      travis_retry composer install --prefer-dist --no-suggest
-    fi
-
-
-script:
-  # Lint PHP files against parse errors.
-  - if [[ "$LINT" == "1" ]]; then composer lint; fi
-
-  # Check that any sniffs available are feature complete.
-  # This also acts as an integration test for the feature completeness script,
-  # which is why it is run against various PHP versions and not in the "Sniff" stage.
-  - if [[ "$LINT" == "1" ]]; then composer check-complete; fi
-
-  # Run the unit tests.
-  - composer run-tests
diff --git a/README.md b/README.md
index 5129c4d..919364a 100644
--- a/README.md
+++ b/README.md
@@ -2,16 +2,15 @@ PHPCSDevTools for developers of PHP_CodeSniffer sniffs
 =====================================================
 
 [![Latest Stable Version](https://poser.pugx.org/phpcsstandards/phpcsdevtools/v/stable)](https://packagist.org/packages/phpcsstandards/phpcsdevtools)
-[![Travis Build Status](https://travis-ci.com/PHPCSStandards/PHPCSDevTools.svg?branch=stable)](https://travis-ci.com/PHPCSStandards/PHPCSDevTools/branches)
 [![Release Date of the Latest Version](https://img.shields.io/github/release-date/PHPCSStandards/PHPCSDevTools.svg?maxAge=1800)](https://github.com/PHPCSStandards/PHPCSDevTools/releases)
 :construction:
 [![Latest Unstable Version](https://img.shields.io/badge/unstable-dev--develop-e68718.svg?maxAge=2419200)](https://packagist.org/packages/phpcsstandards/phpcsdevtools#dev-develop)
-[![Travis Build Status](https://travis-ci.com/PHPCSStandards/PHPCSDevTools.svg?branch=develop)](https://travis-ci.com/PHPCSStandards/PHPCSDevTools/branches)
 [![Last Commit to Unstable](https://img.shields.io/github/last-commit/PHPCSStandards/PHPCSDevTools/develop.svg)](https://github.com/PHPCSStandards/PHPCSDevTools/commits/develop)
 
 [![Minimum PHP Version](https://img.shields.io/packagist/php-v/phpcsstandards/phpcsdevtools.svg?maxAge=3600)](https://packagist.org/packages/phpcsstandards/phpcsdevtools)
 [![Build Status CS](https://github.com/PHPCSStandards/PHPCSDevTools/workflows/CS/badge.svg?branch=develop)](https://github.com/PHPCSStandards/PHPCSDevTools/actions)
-[![Tested on PHP 5.4 to nightly](https://img.shields.io/badge/tested%20on-PHP%205.4%20|%205.5%20|%205.6%20|%207.0%20|%207.1%20|%207.2%20|%207.3%20|%207.4%20|%20nightly-brightgreen.svg?maxAge=2419200)](https://travis-ci.com/PHPCSStandards/PHPCSDevTools)
+[![Build Status Test](https://github.com/PHPCSStandards/PHPCSDevTools/workflows/Test/badge.svg?branch=develop)](https://github.com/PHPCSStandards/PHPCSDevTools/actions)
+[![Tested on PHP 5.4 to nightly](https://img.shields.io/badge/tested%20on-PHP%205.4%20|%205.5%20|%205.6%20|%207.0%20|%207.1%20|%207.2%20|%207.3%20|%207.4%20|%208.0%20|%20nightly-brightgreen.svg?maxAge=2419200)](https://travis-ci.com/PHPCSStandards/PHPCSDevTools)
 
 [![License: LGPLv3](https://poser.pugx.org/phpcsstandards/phpcsdevtools/license)](https://github.com/PHPCSStandards/PHPCSDevTools/blob/stable/LICENSE)
 ![Awesome](https://img.shields.io/badge/awesome%3F-yes!-brightgreen.svg)

From 4adc85e3df1316ea0f99fd81a88e880a644b557b Mon Sep 17 00:00:00 2001
From: jrfnl <jrfnl@users.noreply.github.com>
Date: Sun, 20 Dec 2020 12:46:02 +0100
Subject: [PATCH 15/17] .gitattributes: ignore `.github` directory

Follow up on PR 51
---
 .gitattributes | 1 +
 1 file changed, 1 insertion(+)

diff --git a/.gitattributes b/.gitattributes
index c317e82..d3625d7 100644
--- a/.gitattributes
+++ b/.gitattributes
@@ -7,6 +7,7 @@
 #
 /.gitattributes export-ignore
 /.gitignore export-ignore
+/.github export-ignore
 /phpcs.xml.dist export-ignore
 /phpunit.xml.dist export-ignore
 /phpunit-bootstrap.php export-ignore

From 3ebc306f199f972040ba660e193c5c1928a01c04 Mon Sep 17 00:00:00 2001
From: jrfnl <jrfnl@users.noreply.github.com>
Date: Sun, 20 Dec 2020 11:50:44 +0100
Subject: [PATCH 16/17] PHPCSDebug/Tests: improve further

Further iteration on PR 46, now using more PHPUnit native functionality for the output test.
---
 PHPCSDebug/Tests/Debug/TokenListUnitTest.php | 25 +++++++++++++-------
 1 file changed, 16 insertions(+), 9 deletions(-)

diff --git a/PHPCSDebug/Tests/Debug/TokenListUnitTest.php b/PHPCSDebug/Tests/Debug/TokenListUnitTest.php
index 7f73feb..1c00391 100644
--- a/PHPCSDebug/Tests/Debug/TokenListUnitTest.php
+++ b/PHPCSDebug/Tests/Debug/TokenListUnitTest.php
@@ -36,14 +36,6 @@ class TokenListUnitTest extends UtilityMethodTestCase
      */
     public function testOutput()
     {
-        \ob_start();
-        self::$phpcsFile->process();
-        $output = \ob_get_flush();
-
-        $output = \str_replace(["\r\n", "\r"], "\n", $output);
-
-        $this->assertNotEmpty($output);
-
         $expected  = "\n";
         $expected .= 'Ptr | Ln | Col  | Cond | ( #) | Token Type                 | [len]: Content' . "\n";
         $expected .= '-------------------------------------------------------------------------' . "\n";
@@ -52,6 +44,21 @@ public function testOutput()
         $expected .= '  2 | L3 | C  1 | CC 0 | ( 0) | T_FUNCTION                 | [8]: function' . "\n";
         $expected .= '  3 | L3 | C  9 | CC 0 | ( 0) | T_WHITESPACE               | [0]: ' . "\n\n";
 
-        $this->assertSame($expected, $output);
+        $this->expectOutputString($expected);
+        $this->setOutputCallback([$this, 'normalizeLineEndings']);
+
+        self::$phpcsFile->process();
+    }
+
+    /**
+     * Callback function to normalize line endings in generated output.
+     *
+     * @param string $output The output as send to screen.
+     *
+     * @return string The output with *nix line endings.
+     */
+    public function normalizeLineEndings($output)
+    {
+        return \str_replace(["\r\n", "\r"], "\n", $output);
     }
 }

From 2b9fa1e97fc802176c83e4362a035c4bc48650a3 Mon Sep 17 00:00:00 2001
From: jrfnl <jrfnl@users.noreply.github.com>
Date: Sun, 28 Jun 2020 17:44:26 +0200
Subject: [PATCH 17/17] Readme/Changelog: update for release of v 1.1.0

Includes
* Mention of all relevant changes.
* Adding a link for the version diff.
* Updating the `VERSION` document with the version nr for the release.
* Updating the PHPCSDebug output sample in the README
---
 CHANGELOG.md | 15 ++++++++++++++-
 README.md    | 54 ++++++++++++++++++++++++++--------------------------
 VERSION      |  2 +-
 3 files changed, 42 insertions(+), 29 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 707b6a0..d0db40a 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -10,6 +10,18 @@ This projects adheres to [Keep a CHANGELOG](http://keepachangelog.com/) and uses
 _Nothing yet._
 
 
+## [1.1.0] - 2020-12-20
+
+### Added
+* New column "nested parentheses count" - `( #)` - in the output of the `PHPCSDebug.Debug.TokenList` sniff.
+
+### Changed
+* The minimum required PHPCS version for the `PHPCSDebug` standard has been raised to PHPCS `3.1.0`.
+* `PHPCSDebug.Debug.TokenList`: The column separator has been changed from `::` to `|`.
+* All functionality is now also tested against PHP 8.0.
+* Miscellaneous updates to the development environment and CI scripts.
+
+
 ## [1.0.1] - 2020-06-28
 
 ### Changed
@@ -25,7 +37,8 @@ Initial release containing:
 * A `PHPCSDebug` standard to help debugging sniffs.
 
 
-[Unreleased]: https://github.com/PHPCSStandards/PHPCSDevTools/compare/master...HEAD
+[Unreleased]: https://github.com/PHPCSStandards/PHPCSDevTools/compare/stable...HEAD
+[1.1.0]: https://github.com/PHPCSStandards/PHPCSDevTools/compare/1.0.1...1.1.0
 [1.0.1]: https://github.com/PHPCSStandards/PHPCSDevTools/compare/1.0.0...1.0.1
 
 [Dealerdirect Composer PHPCS plugin]: https://github.com/Dealerdirect/phpcodesniffer-composer-installer/
diff --git a/README.md b/README.md
index 919364a..29742ed 100644
--- a/README.md
+++ b/README.md
@@ -137,34 +137,34 @@ phpcs ./SniffNameUnitTest.inc --standard=YourStandard,PHPCSDebug --sniffs=YourSt
 
 The output will look something along the lines of:
 ```
-Ptr :: Ln :: Col  :: Cond :: Token Type                 :: [len]: Content
+Ptr | Ln | Col  | Cond | ( #) | Token Type                 | [len]: Content
 -------------------------------------------------------------------------
-  0 :: L1 :: C  1 :: CC 0 :: T_OPEN_TAG                 :: [5]: <?php
-
-  1 :: L2 :: C  1 :: CC 0 :: T_WHITESPACE               :: [0]:
-
-  2 :: L3 :: C  1 :: CC 0 :: T_COMMENT                  :: [32]: // Boolean not operator: All OK.
-
-  3 :: L4 :: C  1 :: CC 0 :: T_IF                       :: [2]: if
-  4 :: L4 :: C  3 :: CC 0 :: T_WHITESPACE               :: [1]:
-  5 :: L4 :: C  4 :: CC 0 :: T_OPEN_PARENTHESIS         :: [1]: (
-  6 :: L4 :: C  5 :: CC 0 :: T_WHITESPACE               :: [1]:
-  7 :: L4 :: C  6 :: CC 0 :: T_CONSTANT_ENCAPSED_STRING :: [4]: 'bb'
-  8 :: L4 :: C 10 :: CC 0 :: T_WHITESPACE               :: [1]:
-  9 :: L4 :: C 11 :: CC 0 :: T_IS_NOT_IDENTICAL         :: [3]: !==
- 10 :: L4 :: C 14 :: CC 0 :: T_WHITESPACE               :: [1]:
- 11 :: L4 :: C 15 :: CC 0 :: T_CONSTANT_ENCAPSED_STRING :: [4]: 'bb'
- 12 :: L4 :: C 19 :: CC 0 :: T_WHITESPACE               :: [1]:
- 13 :: L4 :: C 20 :: CC 0 :: T_CLOSE_PARENTHESIS        :: [1]: )
- 14 :: L4 :: C 21 :: CC 0 :: T_WHITESPACE               :: [1]:
- 15 :: L4 :: C 22 :: CC 0 :: T_OPEN_CURLY_BRACKET       :: [1]: {
- 16 :: L4 :: C 23 :: CC 0 :: T_WHITESPACE               :: [0]:
-
- 17 :: L5 :: C  1 :: CC 0 :: T_WHITESPACE               :: [1]: \t
- 18 :: L5 :: C  2 :: CC 0 :: T_IF                       :: [2]: if
- 19 :: L5 :: C  4 :: CC 0 :: T_WHITESPACE               :: [1]:
- 20 :: L5 :: C  5 :: CC 0 :: T_OPEN_PARENTHESIS         :: [1]: (
- 21 :: L5 :: C  6 :: CC 0 :: T_WHITESPACE               :: [0]:
+  0 | L1 | C  1 | CC 0 | ( 0) | T_OPEN_TAG                 | [5]: <?php
+
+  1 | L2 | C  1 | CC 0 | ( 0) | T_WHITESPACE               | [0]:
+
+  2 | L3 | C  1 | CC 0 | ( 0) | T_COMMENT                  | [32]: // Boolean not operator: All OK.
+
+  3 | L4 | C  1 | CC 0 | ( 0) | T_IF                       | [2]: if
+  4 | L4 | C  3 | CC 0 | ( 0) | T_WHITESPACE               | [1]:
+  5 | L4 | C  4 | CC 0 | ( 0) | T_OPEN_PARENTHESIS         | [1]: (
+  6 | L4 | C  5 | CC 0 | ( 1) | T_WHITESPACE               | [1]:
+  7 | L4 | C  6 | CC 0 | ( 1) | T_CONSTANT_ENCAPSED_STRING | [4]: 'bb'
+  8 | L4 | C 10 | CC 0 | ( 1) | T_WHITESPACE               | [1]:
+  9 | L4 | C 11 | CC 0 | ( 1) | T_IS_NOT_IDENTICAL         | [3]: !==
+ 10 | L4 | C 14 | CC 0 | ( 1) | T_WHITESPACE               | [1]:
+ 11 | L4 | C 15 | CC 0 | ( 1) | T_CONSTANT_ENCAPSED_STRING | [4]: 'bb'
+ 12 | L4 | C 19 | CC 0 | ( 1) | T_WHITESPACE               | [1]:
+ 13 | L4 | C 20 | CC 0 | ( 0) | T_CLOSE_PARENTHESIS        | [1]: )
+ 14 | L4 | C 21 | CC 0 | ( 0) | T_WHITESPACE               | [1]:
+ 15 | L4 | C 22 | CC 0 | ( 0) | T_OPEN_CURLY_BRACKET       | [1]: {
+ 16 | L4 | C 23 | CC 0 | ( 0) | T_WHITESPACE               | [0]:
+
+ 17 | L5 | C  1 | CC 0 | ( 0) | T_WHITESPACE               | [1]: \t
+ 18 | L5 | C  2 | CC 0 | ( 0) | T_IF                       | [2]: if
+ 19 | L5 | C  4 | CC 0 | ( 0) | T_WHITESPACE               | [1]:
+ 20 | L5 | C  5 | CC 0 | ( 0) | T_OPEN_PARENTHESIS         | [1]: (
+ 21 | L5 | C  6 | CC 0 | ( 0) | T_WHITESPACE               | [0]:
 ```
 
 PHPCS itself can also display similar information using the `-vv` or `-vvv` verbosity flags, however, when using those, you will receive a *lot* more information than just the token list and, while useful for debugging PHPCS itself, the additional information is mostly just noise when developing a sniff.
diff --git a/VERSION b/VERSION
index 7f20734..1cc5f65 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-1.0.1
\ No newline at end of file
+1.1.0
\ No newline at end of file