Commits on Aug 25, 2023

1. Add PHPStan to QA checks …

   PHPStan is a good addition to our QA toolkit and with improvements PHPStan has made over the years is now a viable tool for us to use (previously it would give way too many false positives).
   
   This commit:
   * Adds a separate job to the `basics` workflow in GH Actions.
       Notes:
       - I've chosen **not** to add PHPStan to the Composer dependencies for two reasons:
           1. It doesn't allow for installation on PHP < 7.2, which would break/block the `composer install` for our test runs.
           2. It would add dependencies which could conflict/cause problems for our test runs due to those defining token constants too.
       - We could potentially use [Phive](https://phar.io/) to still have a setup which can be used locally, but just running locally from a PHPStan PHAR file should work just fine.
       - For CI, PHPStan will be installed as a PHAR file by `setup-php` now.
           This does carry a risk _if_ PHPStan would make breaking changes or if a new release adds rules for the levels being scanned as, in that case, builds could unexpectedly start failing.
           We could fix the version `setup-php` action installs to the current release `1.10.30`, but that adds an additional maintenance burden of having to keep updating the version as PHPStan releases pretty often.
           So, for now, I've elected to run the risk of random failures. If and when those start happening, we can re-evaluate.
       - The PHP version for the CI run is set to PHP 7.4 to prevent PHPStan throwing some errors/notices related to the outdated PHPUnit version being used.
   * Adds a configuration file for PHPStan.
       Notes:
       - PHPStan needs to know about our dependencies (PHPCS et al), so I'm (re-)using the bootstrap file we have for our tests to load the PHPCS autoloader and register the standard with the PHPCS autoloader as we can't add an `autoload` directive to our `composer.json` file as it would cause problems with the PHPCS autoloader.
       - PHPStan flags type checks on properties with a documented type, while - especially for the `public` properties - we cannot always be sure the properties set will be of the correct type. For that reason, I've set `treatPhpDocTypesAsCertain` to `false` (which silences those notices).
   * Adds the configuration file to `.gitattributes` and the typical overload file for the configuration file to `.gitignore`.
   
   Refs:
   * https://phpstan.org/
   * https://phpstan.org/config-reference

   

   jrfnl committed Aug 25, 2023
   Configuration menu

   • View commit details
   • Copy full SHA for a6b8113
   • Browse repository at this point

   Copy the full SHA

   a6b8113 View commit details

   Browse the repository at this point in the history