PHP 8.3 + 8.4 to master branch

.github/workflows/release.yml

@@ -23,7 +23,7 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
@@ -34,35 +34,39 @@ jobs:
           ini-values: phar.readonly=Off, error_reporting=-1, display_errors=On, zend.assertions=1
           # Autoload files generated with Composer 2.3 are not compatible with PHP < 7.0.
           tools: composer:2.2
+        env:
+          fail-fast: true
 
       - name: Install Composer dependencies
-        uses: ramsey/composer-install@v2
+        uses: ramsey/composer-install@v3
         with:
           composer-options: "--no-dev"
+          # Bust the cache at least once a month - output format: YYYY-MM.
+          custom-cache-suffix: $(date -u "+%Y-%m")
 
       # Note: do NOT turn on the requirement checker in the box config as it is no longer
       # compatible with PHP < 7.2.
       - name: Install Box
-        run: wget https://github.com/humbug/box/releases/latest/download/box.phar -O box.phar && chmod 0755 box.phar && pwd
+        run: wget https://github.com/box-project/box/releases/latest/download/box.phar -O box.phar && chmod 0755 box.phar && pwd
 
       - name: Validate configuration
         run: php box.phar validate -i box.json
 
       - name: Building binary...
         run: php box.phar compile -v --config=box.json
 
-      - name: Show info about the build phar with humbug/box
+      - name: Show info about the build phar with box-project/box
         run: php box.phar info -l parallel-lint.phar
 
-      - uses: actions/upload-artifact@v2
+      - uses: actions/upload-artifact@v4
         with:
           name: parallel-lint-phar
           path: ./parallel-lint.phar
 
   verify:
     name: Validate binary on PHP ${{ matrix.php }}
     runs-on: ubuntu-latest
-    continue-on-error: ${{ matrix.php == '8.2' }}
+    continue-on-error: ${{ matrix.php == '8.3' }}
     needs:
       - bundle
 
@@ -81,12 +85,13 @@ jobs:
           - '8.0'
           - '8.1'
           - '8.2'
+          - '8.3'
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
-      - uses: actions/download-artifact@v2
+      - uses: actions/download-artifact@v4
         with:
           name: parallel-lint-phar
 
@@ -108,24 +113,17 @@ jobs:
       - verify
 
     steps:
-      - uses: actions/download-artifact@v2
+      - uses: actions/download-artifact@v4
         with:
           name: parallel-lint-phar
 
       - name: Draft Release
-        uses: actions/create-release@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        uses: softprops/action-gh-release@v2
         with:
           tag_name: ${{ github.ref }}
           release_name: Release ${{ github.ref }}
           draft: true
           prerelease: false
-
-      - name: Upload Phar as Release Asset
-        id: upload-release-asset
-        uses: softprops/action-gh-release@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
+          make_latest: true
           files: parallel-lint.phar
+          fail_on_unmatched_files: true

.github/workflows/test.yml

@@ -23,21 +23,25 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '7.4'
+          php-version: 'latest'
           coverage: none
           tools: cs2pr
 
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Install Composer dependencies
-        uses: ramsey/composer-install@v2
+        uses: ramsey/composer-install@v3
+        with:
+          # Bust the cache at least once a month - output format: YYYY-MM.
+          custom-cache-suffix: $(date -u "+%Y-%m")
 
       - name: Run code sniffer
-        continue-on-error: true
+        id: phpcs
         run: vendor/bin/phpcs --report-full --report-checkstyle=./phpcs-report.xml
 
       - name: Show PHPCS results in PR
+        if: ${{ always() && steps.phpcs.outcome == 'failure' }}
         run: cs2pr ./phpcs-report.xml
 
   bundle:
@@ -46,7 +50,7 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
@@ -57,35 +61,39 @@ jobs:
           ini-values: phar.readonly=Off, error_reporting=-1, display_errors=On, zend.assertions=1
           # Autoload files generated with Composer 2.3 are not compatible with PHP < 7.0.
           tools: composer:2.2
+        env:
+          fail-fast: true
 
       - name: Install Composer dependencies
-        uses: ramsey/composer-install@v2
+        uses: ramsey/composer-install@v3
         with:
           composer-options: "--no-dev"
+          # Bust the cache at least once a month - output format: YYYY-MM.
+          custom-cache-suffix: $(date -u "+%Y-%m")
 
       # Note: do NOT turn on the requirement checker in the box config as it is no longer
       # compatible with PHP < 7.2.
       - name: Install Box
-        run: wget https://github.com/humbug/box/releases/latest/download/box.phar -O box.phar && chmod 0755 box.phar && pwd
+        run: wget https://github.com/box-project/box/releases/latest/download/box.phar -O box.phar && chmod 0755 box.phar && pwd
 
       - name: Validate configuration
         run: php box.phar validate -i box.json
 
       - name: Building binary...
         run: php box.phar compile -v --config=box.json
 
-      - name: Show info about the build phar with humbug/box
+      - name: Show info about the build phar with box-project/box
         run: php box.phar info -l parallel-lint.phar
 
-      - uses: actions/upload-artifact@v2
+      - uses: actions/upload-artifact@v4
         with:
           name: parallel-lint-phar
           path: ./parallel-lint.phar
 
   test:
     name: Run tests on PHP ${{ matrix.php }}
     runs-on: ubuntu-latest
-    continue-on-error: ${{ matrix.php == '8.2' }}
+    continue-on-error: ${{ matrix.php == '8.4' }}
     needs:
       - bundle
 
@@ -104,10 +112,12 @@ jobs:
           - '8.0'
           - '8.1'
           - '8.2'
+          - '8.3'
+          - '8.4'
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
@@ -122,7 +132,18 @@ jobs:
         run: composer remove --dev squizlabs/php_codesniffer --no-update --no-interaction
 
       - name: Install Composer dependencies
-        uses: ramsey/composer-install@v2
+        if: ${{ matrix.php != '8.3' }}
+        uses: ramsey/composer-install@v3
+        with:
+          # Bust the cache at least once a month - output format: YYYY-MM.
+          custom-cache-suffix: $(date -u "+%Y-%m")
+
+      - name: "Install Composer dependencies (PHP 8.3, ignore PHP reqs)"
+        if: ${{ matrix.php == '8.3' }}
+        uses: ramsey/composer-install@v3
+        with:
+          composer-options: --ignore-platform-req=php
+          custom-cache-suffix: $(date -u "+%Y-%m")
 
       - name: 'Integration test 1 - linting own code, no colors'
         continue-on-error: true
@@ -139,7 +160,7 @@ jobs:
         if: ${{ matrix.php >= 5.6 }}
         run: composer test
 
-      - uses: actions/download-artifact@v2
+      - uses: actions/download-artifact@v4
         with:
           name: parallel-lint-phar
 

README.md

@@ -4,7 +4,7 @@
 [![Build Status](https://github.com/php-parallel-lint/PHP-Parallel-Lint/actions/workflows/test.yml/badge.svg)](https://github.com/php-parallel-lint/PHP-Parallel-Lint/actions/workflows/test.yml)
 [![License](https://poser.pugx.org/php-parallel-lint/php-parallel-lint/license.svg)](https://packagist.org/packages/php-parallel-lint/php-parallel-lint)
 
-This application checks syntax of PHP files in parallel.
+This application checks the syntax of PHP files in parallel.
 It can output in plain text, colored text, json and checksyntax formats.
 Additionally `blame` can be used to show commits that introduced the breakage.
 
@@ -72,7 +72,7 @@ It is strongly recommended for existing users of the (unmaintained)
 - `-a`, `--asp`             Set asp_tags to On (default: Off).
 - `-e <ext>`                Check only files with selected extensions separated by comma. (default: php,php3,php4,php5,phtml,phpt)
 - `-j <num>`                Run <num> jobs in parallel (default: 10).
-- `--exclude`               Exclude a file or directory. If you want exclude multiple items, use multiple exclude parameters.
+- `--exclude`               Exclude a file or directory. If you want to exclude multiple items, use multiple exclude parameters.
 - `--colors`                Enable colors in console output. (disables auto detection of color support)
 - `--no-colors`             Disable colors in console output.
 - `--no-progress`           Disable progress in console output.
@@ -116,7 +116,7 @@ Note: The `// lint >= 7.4` comment has to be only the first line of the file and
 
 ## How to upgrade
 
-Are you using `jakub-onderka/php-parallel-lint` package? You can switch to `php-parallel-lint/php-parallel-lint` using:
+Are you using the `jakub-onderka/php-parallel-lint` package? You can switch to `php-parallel-lint/php-parallel-lint` using:
 
     composer remove --dev jakub-onderka/php-parallel-lint
     composer require --dev php-parallel-lint/php-parallel-lint

bin/skip-linting.php

@@ -8,6 +8,12 @@
     $f = @fopen($file, 'r');
     if ($f) {
         $firstLine = fgets($f);
+
+        // ignore shebang line
+        if (strpos($firstLine, '#!') === 0) {
+            $firstLine = fgets($f);
+        }
+
         @fclose($f);
 
         if (preg_match('~<?php\\s*\\/\\/\s*lint\s*([^\d\s]+)\s*([^\s]+)\s*~i', $firstLine, $m)) {

composer.json

@@ -3,6 +3,10 @@
     "description": "This tool checks the syntax of PHP files about 20x faster than serial check.",
     "homepage": "https://github.com/php-parallel-lint/PHP-Parallel-Lint",
     "license": "BSD-2-Clause",
+    "keywords": [
+        "lint",
+        "static analysis"
+    ],
     "authors": [
         {
             "name": "Jakub Onderka",

parallel-lint

@@ -31,7 +31,15 @@ either expressed or implied, of the FreeBSD Project.
  */
 
 if (!defined('PHP_VERSION_ID') || PHP_VERSION_ID < 50300) {
-    fwrite(STDERR, "PHP Parallel Lint requires PHP 5.3.0 or newer." . PHP_EOL);
+    fwrite(
+        STDERR,
+        sprintf(
+            'PHP Parallel Lint requires PHP 5.3.0 or newer.' . PHP_EOL
+            . 'You are using PHP %s (%s).' . PHP_EOL,
+            PHP_VERSION,
+            PHP_BINDIR
+        )
+    );
     exit(254);
 }
 
@@ -70,5 +78,7 @@ if (!$loaded) {
 
 require_once __DIR__ . '/src/polyfill.php';
 
-$app = new JakubOnderka\PhpParallelLint\Application();
+// Prevent parse error on PHP < 5.3 so the version check above can work.
+$className = 'JakubOnderka\PhpParallelLint\Application';
+$app = new $className();
 exit($app->run());

src/Error.php

@@ -107,6 +107,8 @@ function jsonSerialize()
 
 class SyntaxError extends Error
 {
+    const IN_ON_REGEX = '~ in %s on line [0-9]+$~';
+
     /** @var Blame */
     private $blame;
 
@@ -131,8 +133,22 @@ public function getLine()
      */
     public function getNormalizedMessage($translateTokens = false)
     {
-        $message = preg_replace('~^(Parse|Fatal) error: (syntax error, )?~', '', $this->message);
-        $message = preg_replace('~ in ' . preg_quote(basename($this->filePath)) . ' on line [0-9]+$~', '', $message);
+        $message  = preg_replace('~^(Parse|Fatal) error: (syntax error, )?~', '', $this->message);
+        $baseName = basename($this->filePath);
+        $regex    = sprintf(self::IN_ON_REGEX, preg_quote($baseName, '~'));
+        $message  = preg_replace($regex, '', $message, -1, $count);
+
+        if ($count === 0 && strpos($baseName, '\\') !== false) {
+            $baseName = ltrim(strrchr($this->filePath, '\\'), '\\');
+            $regex    = sprintf(self::IN_ON_REGEX, preg_quote($baseName, '~'));
+            $message  = preg_replace($regex, '', $message, -1, $count);
+        }
+
+        if ($count === 0) {
+            $regex   = sprintf(self::IN_ON_REGEX, preg_quote($this->filePath, '~'));
+            $message = preg_replace($regex, '', $message);
+        }
+
         $message = ucfirst($message);
 
         if ($translateTokens) {
@@ -194,7 +210,7 @@ protected function translateTokens($message)
             'T_ECHO' => 'echo'
         );
 
-        return preg_replace_callback('~T_([A-Z_]*)~', function ($matches) use ($translateTokens) {
+        return preg_replace_callback('~(?<!\()T_([A-Z_]*)(?!\))~', function ($matches) use ($translateTokens) {
             list($tokenName) = $matches;
             if (isset($translateTokens[$tokenName])) {
                 $operator = $translateTokens[$tokenName];

src/Manager.php

@@ -17,9 +17,9 @@ class Manager
      * @throws Exception
      * @throws \Exception
      */
-    public function run(Settings $settings = null)
+    public function run($settings = null)
     {
-        $settings = $settings ?: new Settings;
+        $settings = ($settings instanceof Settings) ? $settings : new Settings();
         $output = $this->output ?: $this->getDefaultOutput($settings);
 
         $phpExecutable = PhpExecutable::getPhpExecutable($settings->phpExecutable);

src/Output.php

@@ -348,9 +348,9 @@ protected function writeMark($type)
 
     protected function writePercent()
     {
-        $percent = floor($this->checkedFiles / $this->totalFileCount * 100);
+        $percent = $this->stringWidth(floor($this->checkedFiles / $this->totalFileCount * 100), 3);
         $current = $this->stringWidth($this->checkedFiles, strlen($this->totalFileCount));
-        $this->writeLine(" $current/$this->totalFileCount ($percent %)");
+        $this->writeLine(" $current/$this->totalFileCount ($percent%)");
     }
 
     /**

tests/Output.phpt

@@ -31,6 +31,8 @@ class OutputTest extends Tester\TestCase
 
         $result = (array) json_decode($writer->getLogs());
 
+        Assert::equal(count($errors), count($result));
+
         for ($i = 0; $i < count($result) && $i < count($errors); $i++) {
             $message = $errors[$i]->getMessage();
             $filePath = $errors[$i]->getFilePath();

tests/ParallelLint.lint.phpt

@@ -83,6 +83,16 @@ class ParallelLintLintTest extends Tester\TestCase
         Assert::equal(0, count($result->getErrors()));
     }
 
+    public function testSkipShebang()
+    {
+        $parallelLint = new ParallelLint($this->getPhpExecutable());
+        $result = $parallelLint->lint(array(__DIR__ . '/examples/example-07/example.php'));
+
+        Assert::equal(0, $result->getCheckedFilesCount());
+        Assert::equal(0, $result->getFilesWithSyntaxErrorCount());
+        Assert::equal(1, $result->getSkippedFilesCount());
+    }
+
     public function testInvalidFile()
     {
         $parallelLint = new ParallelLint($this->getPhpExecutable());