feat(codestyle): added phpcs to php tooling, added and applied new PER coding style, tweaked php-cs-fixer configuration accordingly

Author: Rastusik

.editorconfig

@@ -17,6 +17,11 @@ insert_final_newline = false
 [*.{yml,yaml,json}]
 indent_size = 2
 
+[*.{xml,xsd}]
+max_line_length=off
+indent_size=2
+tab_width=2
+
 [composer.json]
 indent_size = 4
 

.gitignore

@@ -13,3 +13,4 @@ Dockerfile.override
 ext
 !ext/.gitignore
 .env
+/.phpcs-cache

.php-cs-fixer.dist.php

@@ -5,10 +5,10 @@
 $finder = PhpCsFixer\Finder::create()
     ->in([__DIR__])
     ->exclude([
+        '.php-cs-fixer.dist.php',
         'tests/Fixtures/Symfony/app/var',
         'tests/Unit/Server/Php8',
         'vendor',
-        'hack',
         'ext',
     ]);
 
@@ -17,27 +17,48 @@
  * @see https://github.com/FriendsOfPHP/PHP-CS-Fixer for rules
  */
 return $config->setRules([
-        '@Symfony' => true,
+        '@PER-CS2.0' => true,
         '@PHP81Migration' => true,
+        'array_indentation' => true,
         'array_syntax' => ['syntax' => 'short'],
+        'blank_line_before_statement' => true,
+        'braces_position' => ['classes_opening_brace' => 'next_line_unless_newline_at_signature_end'],
+        'class_reference_name_casing' => false,
         'combine_consecutive_issets' => true,
         'combine_consecutive_unsets' => true,
         'compact_nullable_type_declaration' => true,
+        'global_namespace_import' => [
+            'import_classes' => true,
+        ],
         'linebreak_after_opening_tag' => true,
         'list_syntax' => ['syntax' => 'short'],
+        'multiline_whitespace_before_semicolons' => ['strategy' => 'no_multi_line'],
+        'native_constant_invocation' => [
+            'fix_built_in' => false,
+            'scope' => 'all',
+        ],
+        'native_function_invocation' => [
+            'include' => [],
+            'exclude' => ['@all'],
+        ],
+        'no_blank_lines_after_class_opening' => true,
         'no_null_property_initialization' => true,
-        'nullable_type_declaration_for_default_null_value' => false,
         'no_useless_else' => true,
         'no_useless_return' => true,
-        'ordered_imports' => ['sort_algorithm' => 'alpha'],
-        'phpdoc_order' => true,
-        'phpdoc_types_order' => true,
+        'nullable_type_declaration_for_default_null_value' => false,
         'ordered_class_elements' => true,
-        'array_indentation' => true,
-        'multiline_whitespace_before_semicolons' => ['strategy' => 'new_line_for_chained_calls'],
-        'no_blank_lines_after_class_opening' => true,
-        'blank_line_before_statement' => true,
-        'class_reference_name_casing' => false,
+        'ordered_imports' => ['sort_algorithm' => 'alpha', 'imports_order' => ['class', 'function', 'const']],
+        'phpdoc_order' => [
+            'order' => ['param', 'return', 'throws'],
+        ],
+        'phpdoc_types_order' => [
+            'null_adjustment' => 'always_last',
+        ],
+        'yoda_style' => [
+            'equal' => false,
+            'identical' => false,
+            'less_and_greater' => false,
+        ],
     ])
-    ->setRiskyAllowed(false)
+    ->setRiskyAllowed(true)
     ->setFinder($finder);

composer.json

@@ -70,6 +70,8 @@
         "phpunit/phpunit": "^10.5",
         "pixelfederation/doctrine-resettable-em-bundle": "^7.0|^8.0",
         "ramsey/uuid": "^4.7",
+        "slevomat/coding-standard": "^8.14",
+        "squizlabs/php_codesniffer": "^3.8",
         "swoole-bundle/z-engine": "^8.1.1|^8.2.1|^8.3.0",
         "swoole/ide-helper": "^5.1.0",
         "symfony/debug-bundle": "^5.4.26|^6.4|^7.0",
@@ -182,7 +184,8 @@
         "allow-plugins": {
             "phpstan/extension-installer": true,
             "phpro/grumphp": false,
-            "symfony/flex": true
+            "symfony/flex": true,
+            "dealerdirect/phpcodesniffer-composer-installer": false
         }
     }
 }

composer.lock

@@ -6,6 +6,7 @@ grumphp:
     complete:
       tasks:
         - phpcsfixer
+        - phpcs
         - phpstan_src
         - phpstan_tests
         - phpunit_unit
@@ -15,6 +16,13 @@ grumphp:
         - phpunit_unit
         - phpunit_feature
   tasks:
+    phpcs:
+      standard: 'phpcs.xml'
+      tab_width: 4
+      whitelist_patterns: [ ]
+      encoding: utf-8
+      sniffs: [ ]
+      triggered_by: [ php ]
     phpcsfixer:
       cache_file: '.php-cs-fixer.cache'
       allow_risky: true