(feat) add new 'table-width' option

Author: ericsizemore

.php-cs-fixer.dist.php

@@ -16,6 +16,7 @@
 $config = new PhpCsFixer\Config();
 $config
     ->setRiskyAllowed(true)
+    ->setUnsupportedPhpVersionAllowed(true)
     ->setRules([
         '@PER-CS'                 => true,
         '@PSR12'                  => true,

CHANGELOG.md

@@ -6,6 +6,26 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 
+## [Unreleased]
+
+ ### Added
+
+  * (feat) CLI option for table width
+    * Thanks to [LeoVie, discussion #311](https://github.com/ericsizemore/phpunit-coverage-check/discussions/311) for the idea.
+
+### Changed
+
+  * The `composer.json` script `psalm:ci` now uses the `psalm` script instead of the (now removed) `psalm:security`.
+  * Updated dev-dependencies, most notably requiring Psalm v7-beta.
+  * Updated `Command\CoverageCheckCommand` to use `__invoke()` instead of `configure()` and `execute()`. This was introduced in [Symfony 7.3](https://symfony.com/blog/new-in-symfony-7-3-invokable-commands-and-input-attributes).
+    * Note, it still extends `Symfony\Component\Console\Command\Command` for now. 
+  * Updated `README.md` for some minor enhancements, and to add information for the new `--table-width` option.
+
+### Removed
+
+  * The `composer.json` script `psalm:security` has been removed.
+
+
 ## [3.0.0] - 2024-12-16
 
 This release is mainly a bump to a PHP 8.3 requirement with some minor refactoring.

README.md

@@ -14,8 +14,8 @@
 
 [PHPUnit Coverage Check](http://github.com/ericsizemore/phpunit-coverage-check/) - Check the code coverage using the clover report of PHPUnit.
 
-This library will read the clover xml report from PHPUnit and calculate the coverage score. 
-Based on the given threshold the application will exit OK if the coverage is higher than the threshold or exit with code 1 if the coverage is lower than the threshold.
+This library will read the clover XML report from PHPUnit and calculate the coverage score. 
+Based on the given threshold, the application will exit OK if the coverage is higher than the threshold or exit with code 1 if the coverage is lower than the threshold.
 
 This library can be used in multiple ways:
 
@@ -27,7 +27,7 @@ See [GitHub Action](#github-action), [Installation](#installation) and [Usage](#
 
 > [!IMPORTANT]
 > This project is not in any way an official ``PHPUnit`` project.
-> Meaning, that it is not associated with, or endorsed by, the ``PHPUnit`` project or its author ``Sebastian Bergmann``.
+> Meaning it is not associated with, or endorsed by, the ``PHPUnit`` project or its author ``Sebastian Bergmann``.
 
 ### GitHub Action
 
@@ -86,10 +86,10 @@ If not already using Phive, you can read more about it [here](https://phar.io/),
 
 ## Usage
 
-There are 2 parameters that must be passed to return the code coverage.
+There are two parameters that must be passed to return the code coverage.
 
-1. The location of the clover xml file, that has been generated by PHPUnit.
-2. The coverage threshold that is acceptable or 'passing'. Min = 1, Max = 100
+1. The location of the clover XML file that PHPUnit has generated.
+2. The coverage threshold that is acceptable or 'passing.' Min = 1, Max = 100.
 
 Generate the `clover.xml` file by using PHPUnit:
 
@@ -105,7 +105,7 @@ You can also add the coverage report generation to your PHPUnit configuration fi
     </report>
 ```
 
-* For more information see the [PHPUnit Documentation](https://docs.phpunit.de/en/10.5/).
+* For more information, see the [PHPUnit Documentation](https://docs.phpunit.de/en/10.5/).
 * Information about the [configuration file](https://docs.phpunit.de/en/10.5/configuration.html) and [commandline options](https://docs.phpunit.de/en/10.5/textui.html#command-line-options).
 
 
@@ -199,6 +199,18 @@ $ php coverage-check tests/fixtures/clover.xml 90 -F
  ----------------------------- -------------------------- ----------
 ```
 
+#### --table-width
+
+The `--table-width` (or `-W`) option will only have an affect if used with the `--show-files` option. The only requirement for this particular option is that you must pass an integer 
+value. For example:
+
+```bash
+$ php coverage-check tests/fixtures/clover.xml 90 -F -W 120
+
+# ...or
+$ php coverage-check tests/fixtures/clover.xml 90 --show-files --table-width 120
+```
+
 ## About
 
 ### Requirements
@@ -212,7 +224,8 @@ $ php coverage-check tests/fixtures/clover.xml 90 -F
 
 This library is a fork of/based upon [rregeer/phpunit-coverage-check](https://github.com/richardregeer/phpunit-coverage-check/) by [Richard Regeer](https://github.com/richardregeer).
 
-Most of this library has been rewritten from the ground up, to replace and improve a majority of the original library. The overall idea, and key pieces of the calculation, are thanks to the original library. Many thanks and much appreciation to Richard Regeer for his wonderful work.
+Most of this library has been rewritten from the ground up, to replace and improve the majority of the original library. The overall idea, and key pieces of the calculation, are thanks to the original library. 
+Many thanks and much appreciation to Richard Regeer for his wonderful work.
 
 - Author: [Eric Sizemore](https://github.com/ericsizemore)
 - Thanks to [Richard Regeer](https://github.com/richardregeer) for the original `phpunit-coverage-check` library this library is forked from.

bin/coverage-check

@@ -49,10 +49,7 @@ use Esi\CoverageCheck\Application;
 use Esi\CoverageCheck\Command\CoverageCheckCommand;
 use Esi\CoverageCheck\CoverageCheck;
 
-$command     = new CoverageCheckCommand(new CoverageCheck());
-$commandName = $command->getName() ?? 'coverage:check';
-
 $console = new Application();
-$console->add($command);
-$console->setDefaultCommand($commandName, true);
+$console->add(new CoverageCheckCommand(new CoverageCheck()));
+$console->setDefaultCommand(Application::COMMAND_NAME, true);
 $console->run();

composer.json

@@ -57,20 +57,20 @@
         "php": "^8.3",
         "ext-libxml": "*",
         "ext-simplexml": "*",
-        "symfony/console": "^7.2"
+        "symfony/console": "^7.3"
     },
     "require-dev": {
-        "friendsofphp/php-cs-fixer": "^3.68",
+        "friendsofphp/php-cs-fixer": "^3.83",
         "phpstan/extension-installer": "^1.4",
         "phpstan/phpstan": "^2.1",
         "phpstan/phpstan-deprecation-rules": "^2.0",
         "phpstan/phpstan-phpunit": "^2.0",
         "phpstan/phpstan-strict-rules": "^2.0",
-        "phpunit/phpunit": "^11.5 || ^12.0",
-        "psalm/plugin-phpunit": "^0.19.0",
+        "phpunit/phpunit": "^12.2",
+        "psalm/plugin-phpunit": "^0.19.5",
         "psalm/plugin-symfony": "^5.2.7",
-        "rector/rector": "^2.0",
-        "vimeo/psalm": "^6.5"
+        "rector/rector": "^2.1",
+        "vimeo/psalm": "^7.0.0-beta11"
     },
     "minimum-stability": "dev",
     "prefer-stable": true,
@@ -92,7 +92,7 @@
             "phpstan/extension-installer": true
         },
         "platform": {
-            "php": "8.3.0"
+            "php": "8.3.99"
         }
     },
     "extra": {
@@ -112,16 +112,15 @@
             "@psalm:shepherd"
         ],
         "clear-build": "rm -rf ./build/*",
-        "code-coverage": "@php bin/coverage-check build/logs/clover.xml 100",
+        "code-coverage": "@php bin/coverage-check build/logs/clover.xml 100 --show-files --table-width 110",
         "phpcs:check": "@phpcs:fix --dry-run --diff",
         "phpcs:fix": "vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.dist.php",
         "phpstan": "vendor/bin/phpstan analyse -c phpstan.neon -vvv",
         "phpunit": "vendor/bin/phpunit",
         "phpunit:migrate": "@phpunit --migrate-configuration",
         "psalm": "vendor/bin/psalm -c psalm.xml --no-cache --show-info=true",
         "psalm:baseline": "@psalm --no-diff --set-baseline=psalm-baseline.xml",
-        "psalm:ci": "@psalm:security --shepherd --report=results.sarif",
-        "psalm:security": "@psalm --no-diff --taint-analysis",
+        "psalm:ci": "@psalm --shepherd --report=results.sarif",
         "psalm:shepherd": "@psalm --no-diff --shepherd --stats",
         "refactor:check": "@refactor:fix --dry-run",
         "refactor:fix": "vendor/bin/rector process"