Features/php cs fixer (#3598)

* introduces new linter for PHP-CS-Fixer (see feature report #3550)

* changes after running build.py

* fix cspell dict for missing words related to #3550

* wrong filename used for testing new linter PHP_PHPCSFIXER (see #3550)

* automation about php-cs-fixer

* quick fix for PHP-CS-Fixer util unit tests

* ugly quick fix for new PHP-CS-Fixer linter

* docs and automation files

* clean-up code

* [MegaLinter] Apply linters fixes

* Workaround for test case names

* [MegaLinter] Apply linters fixes

* Fix

---------

Co-authored-by: llaville <llaville@users.noreply.github.com>
Co-authored-by: nvuillam <nicolas.vuillamy@gmail.com>
Co-authored-by: nvuillam <nvuillam@users.noreply.github.com>

.automation/generated/linter-links-previews.json

@@ -324,6 +324,11 @@
     "image": null,
     "title": "PHP: Hypertext Preprocessor"
   },
+  "php-cs-fixer": {
+    "description": "PHP Coding Standards Fixer",
+    "image": null,
+    "title": "PHP Coding Standards Fixer"
+  },
   "phpcs": {
     "description": "PHP_CodeSniffer tokenizes PHP files and detects violations of a defined set of coding standards. - squizlabs/PHP_CodeSniffer",
     "image": "https://avatars2.githubusercontent.com/u/997547?s=400&v=4",

.automation/generated/linter-versions.json

@@ -62,6 +62,7 @@
     "npm-package-json-lint": "7.1.0",
     "perlcritic": "1.152",
     "php": "7.4.26",
+    "php-cs-fixer": "3.58.1",
     "phpcs": "3.10.1",
     "phplint": "9.3.1",
     "phpstan": "1.11.3",

.automation/test/php/reports/ERROR-PHP_PHPCSFIXER.txt

@@ -0,0 +1,16 @@
+Results of php-cs-fixer linter (version 3.58.1)
+See documentation on https://megalinter.io/latest/descriptors/php_php_cs_fixer/
+-----------------------------------------------
+
+❌ [ERROR] for workspace /tmp/lint
+Linter raw log:
+PHP CS Fixer 3.58.1 7th Gear by Fabien Potencier, Dariusz Ruminski and contributors.
+PHP runtime: 8.3.7
+Running analysis on 1 core sequentially.
+You can enable parallel runner and speed up the analysis! Please see https://cs.symfony.com/doc/usage.html for more information.
+Loaded config default from "/action/lib/.automation/.php-cs-fixer.dist.php".
+Using cache file ".php-cs-fixer.cache".
+
+Files that were not fixed due to errors reported during linting before fixing:
+   1) ./php_bad_1.php
+   2) ./php_bad_2.php

.cspell.json

@@ -73,6 +73,7 @@
         "fastq",
         "ffenses",
         "filelist",
+        "friendsofphp",
         "fs.realpath",
         "gfch",
         "gotit",
@@ -104,6 +105,7 @@
         "minizlib",
         "mkdirp",
         "msgon",
+        "netbeans",
         "nextick",
         "numprocesses",
         "noni",
@@ -355,6 +357,7 @@
         "PERLCRITIC",
         "PHAR",
         "PHPCS",
+        "PHPCSFIXER",
         "PHPSTAN",
         "PIPESTATUS",
         "PIPVENV",

.github/workflows/deploy-BETA-linters.yml

@@ -132,6 +132,7 @@ jobs:
             "php_phpstan",
             "php_psalm",
             "php_phplint",
+            "php_phpcsfixer",
             "powershell_powershell",
             "powershell_powershell_formatter",
             "protobuf_protolint",

.github/workflows/deploy-DEV-linters.yml

@@ -103,6 +103,7 @@ jobs:
             "php_phpstan",
             "php_psalm",
             "php_phplint",
+            "php_phpcsfixer",
             "powershell_powershell",
             "powershell_powershell_formatter",
             "protobuf_protolint",

.github/workflows/deploy-RELEASE-linters.yml

@@ -107,6 +107,7 @@ jobs:
             "php_phpstan",
             "php_psalm",
             "php_phplint",
+            "php_phpcsfixer",
             "powershell_powershell",
             "powershell_powershell_formatter",
             "protobuf_protolint",

Dockerfile

@@ -641,6 +641,10 @@ RUN --mount=type=secret,id=GITHUB_TOKEN GITHUB_AUTH_TOKEN="$(cat /run/secrets/GI
 RUN --mount=type=secret,id=GITHUB_TOKEN GITHUB_AUTH_TOKEN="$(cat /run/secrets/GITHUB_TOKEN)" && export GITHUB_AUTH_TOKEN && phive --no-progress install overtrue/phplint --force-accept-unsigned -g
 
 
+# php-cs-fixer installation
+RUN --mount=type=secret,id=GITHUB_TOKEN GITHUB_AUTH_TOKEN="$(cat /run/secrets/GITHUB_TOKEN)" && export GITHUB_AUTH_TOKEN && composer global require friendsofphp/php-cs-fixer
+
+
 # powershell installation
 RUN pwsh -c 'Install-Module -Name PSScriptAnalyzer -RequiredVersion ${PSSA_VERSION} -Scope AllUsers -Force'
 

TEMPLATES/.php-cs-fixer.dist.php

@@ -0,0 +1,12 @@
+<?php
+
+$finder = (new PhpCsFixer\Finder())
+    ->in('.')
+;
+
+return (new PhpCsFixer\Config())
+    ->setRules([
+        '@PER-CS' => true,
+    ])
+    ->setFinder($finder)
+;

docs/standalone-linters.md

@@ -64,6 +64,7 @@
 | PHP_PHPSTAN                       | oxsecurity/megalinter-only-php_phpstan:beta                       |            ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-php_phpstan/beta)            |
 | PHP_PSALM                         | oxsecurity/megalinter-only-php_psalm:beta                         |             ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-php_psalm/beta)             |
 | PHP_PHPLINT                       | oxsecurity/megalinter-only-php_phplint:beta                       |            ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-php_phplint/beta)            |
+| PHP_PHPCSFIXER                    | oxsecurity/megalinter-only-php_phpcsfixer:beta                    |          ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-php_phpcsfixer/beta)           |
 | POWERSHELL_POWERSHELL             | oxsecurity/megalinter-only-powershell_powershell:beta             |       ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-powershell_powershell/beta)       |
 | POWERSHELL_POWERSHELL_FORMATTER   | oxsecurity/megalinter-only-powershell_powershell_formatter:beta   |  ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-powershell_powershell_formatter/beta)  |
 | PROTOBUF_PROTOLINT                | oxsecurity/megalinter-only-protobuf_protolint:beta                |        ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-protobuf_protolint/beta)         |

flavors/cupcake/Dockerfile

@@ -467,6 +467,10 @@ RUN --mount=type=secret,id=GITHUB_TOKEN GITHUB_AUTH_TOKEN="$(cat /run/secrets/GI
 RUN --mount=type=secret,id=GITHUB_TOKEN GITHUB_AUTH_TOKEN="$(cat /run/secrets/GITHUB_TOKEN)" && export GITHUB_AUTH_TOKEN && phive --no-progress install overtrue/phplint --force-accept-unsigned -g
 
 
+# php-cs-fixer installation
+RUN --mount=type=secret,id=GITHUB_TOKEN GITHUB_AUTH_TOKEN="$(cat /run/secrets/GITHUB_TOKEN)" && export GITHUB_AUTH_TOKEN && composer global require friendsofphp/php-cs-fixer
+
+
 # mypy installation
 ENV MYPY_CACHE_DIR=/tmp
 

flavors/cupcake/flavor.json

@@ -52,6 +52,7 @@
         "PHP_PHPSTAN",
         "PHP_PSALM",
         "PHP_PHPLINT",
+        "PHP_PHPCSFIXER",
         "PYTHON_PYLINT",
         "PYTHON_BLACK",
         "PYTHON_FLAKE8",

flavors/php/Dockerfile

@@ -328,6 +328,10 @@ RUN --mount=type=secret,id=GITHUB_TOKEN GITHUB_AUTH_TOKEN="$(cat /run/secrets/GI
 RUN --mount=type=secret,id=GITHUB_TOKEN GITHUB_AUTH_TOKEN="$(cat /run/secrets/GITHUB_TOKEN)" && export GITHUB_AUTH_TOKEN && phive --no-progress install overtrue/phplint --force-accept-unsigned -g
 
 
+# php-cs-fixer installation
+RUN --mount=type=secret,id=GITHUB_TOKEN GITHUB_AUTH_TOKEN="$(cat /run/secrets/GITHUB_TOKEN)" && export GITHUB_AUTH_TOKEN && composer global require friendsofphp/php-cs-fixer
+
+
 # protolint installation
 # Managed with COPY --link --from=protolint /usr/local/bin/protolint /usr/bin/
 

flavors/php/flavor.json

@@ -38,6 +38,7 @@
         "PHP_PHPSTAN",
         "PHP_PSALM",
         "PHP_PHPLINT",
+        "PHP_PHPCSFIXER",
         "PROTOBUF_PROTOLINT",
         "REPOSITORY_CHECKOV",
         "REPOSITORY_GIT_DIFF",