Tools - don't preinstall any QA tools

- it simplifies composer installation and conflicts (install what you need)
- abandoned tools can be ignored
- it slightly complicates default UX if user does not use docker image
- update composer in dockerfile otherwise 7.2 cannot install deptrac + it prevents errors caused by deprecated composer

Author: zdenekdrahos

.docker/Dockerfile

@@ -2,7 +2,8 @@ ARG COMPOSER_VERSION=1.8.0
 FROM composer:$COMPOSER_VERSION
 
 RUN apk add --update libxslt-dev && \
-    docker-php-ext-install xsl
+    docker-php-ext-install xsl && \
+    composer self-update
 
 COPY ./composer.json ./bin/suggested-tools.sh /phpqa/
 RUN (cd /phpqa && \

.github/workflows/php.yml

@@ -57,7 +57,7 @@ jobs:
         if [[ $INSTALL_SUGGESTED_TOOLS == "yes" ]]; then
             PHP_VERSION=$PHP_VERSION bin/suggested-tools.sh install;
         else
-            composer install --no-interaction --no-progress;
+            PREINSTALLED_TOOLS=legacy bin/suggested-tools.sh install;
         fi
         php tests/.phpunit/fix-typehints.php;
 

README.md

@@ -33,22 +33,19 @@ Will you create e.g. Jenkins project/task for each bundle?
 
 ## Available [tools](https://github.com/ziadoz/awesome-php#code-analysis)
 
-Tool| Description
------------------------------------------------------------------------ | ----------------------------- |
-[phploc](https://github.com/sebastianbergmann/phploc) | Measure the size of a PHP project |
-[phpcpd](https://github.com/sebastianbergmann/phpcpd) | Copy/Paste Detector (CPD) for PHP code |
-[phpcs](https://github.com/squizlabs/PHP_CodeSniffer) | Detect violations of a coding standard |
-[pdepend](https://github.com/pdepend/pdepend) | PHP adaptation of JDepend |
-[phpmd](https://github.com/phpmd/phpmd) | Scan PHP project for messy code |
-[phpmetrics](https://github.com/Halleck45/PhpMetrics) | Static analysis tool for PHP |
+**Since version [1.27] no tools are preinstalled if you run `composer require`!**
 
-##### Suggested tools
-
-Newly added tools aren't preinstalled. You have to install relevant composer packages if
-you want to use them.
+You have to install relevant composer packages if you want to use them,
+or define `binary` path in `.phpqa.yml`, or use official docker image with preinstalled tools.
 
 Tool | PHP | Supported since | Description |
 ---- | --- | --------------- | ----------- |
+[phploc](https://github.com/sebastianbergmann/phploc) | `>= 5.4` | `1.0` | Measure the size of a PHP project |
+[phpcpd](https://github.com/sebastianbergmann/phpcpd) | `>= 5.4` | `1.0` | Copy/Paste Detector (CPD) for PHP code |
+[phpcs](https://github.com/squizlabs/PHP_CodeSniffer) | `>= 5.4` | `1.0` | Detect violations of a coding standard |
+[pdepend](https://github.com/pdepend/pdepend) | `>= 5.4` | `1.0` | PHP adaptation of JDepend |
+[phpmd](https://github.com/phpmd/phpmd) | `>= 5.4` | `1.0` | Scan PHP project for messy code |
+[phpmetrics](https://github.com/Halleck45/PhpMetrics) | `>= 5.4` | `1.0` | Static analysis tool for PHP |
 [security-checker](https://github.com/enlightn/security-checker) | `>= 5.6` | `1.24` | Check composer.lock for known security issues |
 [php-cs-fixer](http://cs.sensiolabs.org/) | [`>= 5.3`](https://github.com/EdgedesignCZ/phpqa/pull/66#discussion_r115206573) | `1.12` | Automatically detect and fix PHP coding standards issues |
 [phpunit](https://github.com/phpunit/phpunit) | `>= 5.3` | `1.13` | The PHP Unit Testing framework |

appveyor.yml

@@ -42,7 +42,7 @@ install:
     - appveyor-retry appveyor DownloadFile https://getcomposer.org/composer.phar
     # install
     - cd c:\projects\phpqa
-    - appveyor-retry composer install --no-progress --profile
+    - appveyor-retry composer require squizlabs/php_codesniffer phpmd/phpmd pdepend/pdepend phpmetrics/phpmetrics phploc/phploc sebastian/phpcpd --no-progress --profile
 
 test_script:
     - cd C:\projects\phpqa

bin/suggested-tools.sh

@@ -16,6 +16,7 @@ SELECTED_MODE="$1"
 COMPOSER_REQUIRE_MODES="$2"
 
 PHP_VERSION=${PHP_VERSION:-"7"}
+PREINSTALLED_TOOLS=${PREINSTALLED_TOOLS:-""}
 
 run () {
     TOOLS=$(get_tools)
@@ -40,9 +41,12 @@ show_help() {
 }
 
 get_tools () {
-    TOOLS="php-parallel-lint/php-parallel-lint php-parallel-lint/php-console-highlighter friendsofphp/php-cs-fixer"
-    if [[ ${PHP_VERSION:0:1} != "5" ]]; then
-        TOOLS="${TOOLS} psalm/phar phpstan/phpstan nette/neon deptrac/deptrac enlightn/security-checker"
+    TOOLS="squizlabs/php_codesniffer phpmd/phpmd pdepend/pdepend phpmetrics/phpmetrics phploc/phploc sebastian/phpcpd"
+    if [[ $PREINSTALLED_TOOLS != "legacy" ]]; then
+        TOOLS="${TOOLS} php-parallel-lint/php-parallel-lint php-parallel-lint/php-console-highlighter friendsofphp/php-cs-fixer"
+        if [[ ${PHP_VERSION:0:1} != "5" ]]; then
+            TOOLS="${TOOLS} psalm/phar phpstan/phpstan nette/neon deptrac/deptrac enlightn/security-checker"
+        fi
     fi
     echo $TOOLS
 }

composer.json

@@ -20,28 +20,23 @@
         "php": ">=5.4",
         "ext-xsl": "*",
         "consolidation/robo": "~0.5|>=1",
-        "phpmd/phpmd" : "*",
-        "phploc/phploc": "*",
-        "symfony/dependency-injection": ">=2.8.50",
-        "symfony/filesystem": ">=2.8",
-        "symfony/process": ">=2.8",
-        "symfony/finder": ">=2.8",
-        "symfony/yaml": ">=2.8",
-        "twig/twig": "~1.38|~2.7|~3",
-        "pdepend/pdepend": "*",
-        "sebastian/phpcpd": "*",
-        "squizlabs/php_codesniffer": "*",
-        "phpmetrics/phpmetrics": "*"
+        "twig/twig": "~1.38|~2.7|>=3"
     },
     "suggest": {
+        "squizlabs/php_codesniffer": "Detect coding standard violation (phpcs) and fix them (phpcbf)",
         "enlightn/security-checker": "Check composer.lock for known security issues",
         "friendsofphp/php-cs-fixer": "A tool to automatically fix PHP coding standards issues",
         "phpunit/phpunit": "The PHP Unit Testing framework",
         "phpstan/phpstan": "PHP Static Analysis Tool - discover bugs in your code without running it!",
         "psalm/phar": "A static analysis tool for finding errors in PHP applications",
         "php-parallel-lint/php-parallel-lint": "Check PHP syntax",
         "php-parallel-lint/php-console-highlighter": "Colored output in parallel-lint",
-        "deptrac/deptrac": "Enforce rules for dependencies between software layers"
+        "deptrac/deptrac": "Enforce rules for dependencies between software layers",
+        "phpmd/phpmd" : "user friendly metrics from pdepend",
+        "pdepend/pdepend": "Analyze you the quality of your design in terms of extensibility, reusability and maintainability",
+        "phpmetrics/phpmetrics": "Metrics about PHP project and classes in HTML report",
+        "phploc/phploc": "Abandoned measuring the size of a PHP project",
+        "sebastian/phpcpd": "Abandoned copy-paste detector"
     },
     "require-dev": {
         "hamcrest/hamcrest-php": ">=2.0.1",

phpqa

@@ -20,14 +20,14 @@ if (getenv('COMPOSER_BIN_DIR') && getenv('COMPOSER_VENDOR_DIR')) {
         "{$projectRoot}/" . getenv('COMPOSER_BIN_DIR'),
     ];
     foreach ($binPaths as $bin) {
-        if (is_file("{$bin}/phploc")) {
+        if (is_file("{$bin}/phpqa")) {
             define('COMPOSER_BINARY_DIR', "{$bin}/");
             break;
         }
     }
 }
 
-if (!defined('COMPOSER_BINARY_DIR') || !is_file(COMPOSER_BINARY_DIR . 'phploc')) {
+if (!defined('COMPOSER_BINARY_DIR') || !is_dir(COMPOSER_BINARY_DIR)) {
     die("Composer binary directory was not found (define path in environment variable 'COMPOSER_BIN_DIR')\n");
 }