Refactor the requirements check #971
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jrfnl
changed the base branch from
phpcs-4.0/feature/ghactions-enable-ci
to
phpcs-4.0/feature/drop-support-php-lt-7.2
jrfnl
force-pushed
the
phpcs-4.0/feature/530-refactor-requirements-check
branch
from
744da95 to
ff711f8
Compare
fredden
approved these changes
Apr 14, 2025
jrfnl
force-pushed
the
phpcs-4.0/feature/drop-support-php-lt-7.2
branch
from
8de604b to
a7a27b9
Compare
Base automatically changed from
phpcs-4.0/feature/drop-support-php-lt-7.2
to
4.x
April 14, 2025 12:04
The requirements check (minimum PHP version + extensions) needs to stay PHP cross-version compatible to allow it to work properly. As things were, what with the autoloader being loaded before the requirements check was run and the requirements check being part of the `Runner` class, this would block any PHP modernizations from being made to these files. It is my opinion that the requirements check: 1. Should be run before anything else. 2. Should involve as few files as possible to prevent the check blocking code modernizations and raising the cognitive load for contributors. To this end, I'm introducing a new `requirements.php` file in the project root. This file will be loaded in the bootstrapping of PHPCS/PHPCBF, both when running via the plain files (Composer, git clone), as well as when running via the PHAR file. This means there will now be only three files which need to stay PHP cross-version compatible: * `bin/phpcs` * `bin/phpcbf` * `requirements.php` A very explicit warning about the need for these files to stay cross-version compatible has been added to in the file docblock of each of these files. The PHP minimum for these three files has been set to PHP 5.3 for the following reasons: 1. The minimum PHP version for PHPCS 3.x was PHP 5.4, so chances of people trying to run PHPCS on a PHP version older than PHP 5.4 are slim. 2. The requirements check in PHPCS 3.x was already broken due to the use of a) namespace separators in the `bin/*` files (PHP 5.3+) and b) short arrays in the actual requirements check code (PHP 5.4+). 3. Testing - and therefore safeguarding - the functionality of the requirements check on PHP versions older than PHP 5.3 is not possible as PHP < 5.3 is [not supported by setup-php](https://github.com/shivammathur/setup-php#tada-php-support). Alongside the changes to the requirement checking, this commit also introduces a new GH Actions workflow to safeguard the requirements check for the future (and two helper scripts for use in the workflow). This workflow will only run selectively when files involved in the requirements check, and the testing thereof, are changed. Note: the exit code has not been changed (yet). This will be handled separately when addressing issue 184. Fixes 530
jrfnl
force-pushed
the
phpcs-4.0/feature/530-refactor-requirements-check
branch
from
ff711f8 to
1972495
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The requirements check (minimum PHP version + extensions) needs to stay PHP cross-version compatible to allow it to work properly.
As things were, what with the autoloader being loaded before the requirements check was run and the requirements check being part of the
Runnerclass, this would block any PHP modernizations from being made to these files.It is my opinion that the requirements check:
To this end, I'm introducing a new
requirements.phpfile in the project root. This file will be loaded in the bootstrapping of PHPCS/PHPCBF, both when running via the plain files (Composer, git clone), as well as when running via the PHAR file.This means there will now be only three files which need to stay PHP cross-version compatible:
bin/phpcsbin/phpcbfrequirements.phpA very explicit warning about the need for these files to stay cross-version compatible has been added to in the file docblock of each of these files.
The PHP minimum for these three files has been set to PHP 5.3 for the following reasons:
bin/*files (PHP 5.3+) and b) short arrays in the actual requirements check code (PHP 5.4+).Alongside the changes to the requirement checking, this commit also introduces a new GH Actions workflow to safeguard the requirements check for the future (and two helper scripts for use in the workflow).
This workflow will only run selectively when files involved in the requirements check, and the testing thereof, are changed.
Note: the exit code has not been changed (yet). This will be handled separately when addressing issue #184.
Suggested changelog entry
N/A
Related issues/external references
Fixes #530