feat(work in progress): use PHP CS Fixer for Pimcore projects

Resolves #41

Author: youwe-petervanderwal

CHANGELOG.md

@@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Upstream projects not having phpunit installed will install phpunit with an @stable version.
 - Added support for Drupal configuration and templates.
 - Migration docs for migration from v2 to v3 of the testing suite.
+- Pimcore coding standards now uses PHP CS Fixer to support PER 2.0 coding standards
 
 ### Changed
 - [BREAKING] The composer.json configurations `config.youwe-testing-suite.type` and `config.mediact-testing-suite.type`
@@ -32,6 +33,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Updated remote schema location URL for phpmd rulesets to prevent redirecting which may cause flaky builds.
 - Bumped phpro/grumphp-shim dependency from v1 to v2
 - Bumped youwe/composer-dependency-installer from v1 to v2
+- Default Pimcore coding standards disables PHPCS in favour of PHP CS Fixer
 
 ### Removed
 - Removed support for EOL PHP versions. Projects running PHP < 8.1 can stick to version 2 of the testing-suite.

config/pimcore/grumphp.yml

@@ -3,4 +3,21 @@ imports:
 
 # Extend git triggers with common pimcore constructs
 parameters:
-  git_blacklist.triggered_by: [ 'php', 'js', 'twig' ]
+  git_blacklist.triggered_by: [ 'php', 'js', 'twig' ]
+
+  phpcsfixer.allow_risky: false
+  phpcsfixer.verbose: true
+  phpcsfixer.diff: true
+  phpcsfixer.triggered_by: ['php']
+
+grumphp:
+  tasks:
+    # Disable PHPCS in favor of PHP CS Fixer
+    phpcs:
+      metadata:
+        enabled: false
+    phpcsfixer:
+      allow_risky: '%phpcsfixer.allow_risky%'
+      verbose: '%phpcsfixer.verbose%'
+      diff: '%phpcsfixer.diff%'
+      triggered_by: '%phpcsfixer.triggered_by%'

config/pimcore/ruleset.xml

@@ -55,6 +55,13 @@ class PackagesInstaller implements InstallerInterface
                 'updateDependencies' => true,
             ]
         ],
+        'pimcore' => [
+            // For Pimcore, use PHP CS Fixer instead of PHP Code Sniffer, because the latter lacks support for PER
+            // coding standards
+            'php-cs-fixer/shim' => [
+                'version' => '@stable',
+            ],
+        ],
     ];
 
     /**

src/Installer/PackagesInstaller.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+$finder = PhpCsFixer\Finder::create()                       // @phpstan-ignore class.notFound (class lives in phar file and can't be seen)
+    ->in(__DIR__)
+    ->exclude([
+        /**
+         * Default Pimcore excludes
+         */
+
+        // Symfony files
+        'bin/console',
+        'public/index.php',
+        // Full var folder, this contains all kind of auto-generated files (from cache to class definitions)
+        'var',
+        // Configuration written by Pimcore (which is written to var/ or to config/pimcore depending on settings)
+        'config/pimcore',
+
+        /**
+         * Add any project specific exclude below
+         */
+    ]);
+
+$config = new PhpCsFixer\Config();                          // @phpstan-ignore class.notFound (class lives in phar file and can't be seen)
+return $config                                              // @phpstan-ignore class.notFound (class lives in phar file and can't be seen)
+    ->setRules([
+        // Alias for the latest revision of PER-CS rules, replace with '@PER-CS2.0' if you want explicitly use PER 2.0
+        '@PER-CS' => true,
+    ])
+    ->setFinder($finder);

templates/files/pimcore/.php-cs-fixer.dist.php

@@ -0,0 +1,59 @@
+# symfony default
+/.web-server-pid
+/config/pimcore/parameters.yml
+/public/bundles/
+
+# local config
+/.env.local
+/.env.local.php
+/.env.*.local
+
+/var/*
+!/var/.gitkeep
+!/var/classes/
+/var/classes/DataObject
+
+!/var/config
+/var/config/debug-mode.php
+/var/config/maintenance.php
+
+!/var/admin/
+/var/admin/*
+!/var/admin/custom-logo.image
+
+# project specific recommendations
+/var/config/tag-manager.php
+/var/config/reports.php
+/var/config/portal
+
+/public/var/
+/public/sitemap*.xml
+
+# PHP-CS-Fixer
+/.php_cs
+/.php_cs.cache
+
+# composer
+/vendor/
+/build/deployer/vendor
+
+# PhpStorm / IDEA
+.idea
+# NetBeans
+nbproject
+# VS Code
+.prettierrc
+
+# temp
+.temp
+
+.DS_Store
+*.swp
+
+# PhpUnit
+phpunit.result.xml
+.phpunit.result.cache
+
+# PHP CS Fixer cache & local config
+.php-cs-fixer.cache
+.php-cs-fixer.php

templates/files/pimcore/dotgitignore

@@ -1,3 +1,5 @@
-{pimcore/,}phpcs.xml
+{pimcore/,}.php-cs-fixer.dist.php
+{pimcore/dot,.}gitignore
+{pimcore/,}grumphp.yml
 {pimcore/,}phpmd.xml
 {pimcore/,}phpstan.neon