Format code with PHP-CS-Fixer

Author: theodorejb

.github/workflows/php.yml

@@ -34,3 +34,7 @@ jobs:
       - name: Perform static analysis
         run: composer analyze -- --error-format=github
         if: ${{ matrix.php == '8.4' }}
+
+      - name: Check Formatting
+        run: vendor/bin/php-cs-fixer fix -v --dry-run --stop-on-violation --using-cache=no
+        if: ${{ matrix.php == '8.3' }}

.php-cs-fixer.php

@@ -0,0 +1,61 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()
+    ->path([
+        'src/',
+        'tests/',
+    ])
+    ->notPath([
+        'src/Parser.php',
+    ])
+    ->ignoreVCSIgnored(true)
+    ->append([__FILE__])
+    ->in(__DIR__);
+
+$config = new PhpCsFixer\Config();
+return $config
+    ->setRules([
+        '@PER-CS' => true,
+        'align_multiline_comment' => true,
+        'array_syntax' => true,
+        'binary_operator_spaces' => true,
+        'class_attributes_separation' => ['elements' => ['method' => 'one']],
+        'class_reference_name_casing' => true,
+        'clean_namespace' => true,
+        'combine_consecutive_unsets' => true,
+        'declare_parentheses' => true,
+        'integer_literal_case' => true,
+        'lambda_not_used_import' => true,
+        'linebreak_after_opening_tag' => true,
+        'method_chaining_indentation' => true,
+        'multiline_comment_opening_closing' => true,
+        'native_function_casing' => true,
+        'no_alternative_syntax' => true,
+        'no_blank_lines_after_phpdoc' => true,
+        'no_empty_comment' => true,
+        'no_empty_phpdoc' => true,
+        'no_empty_statement' => true,
+        'no_extra_blank_lines' => true,
+        'no_spaces_around_offset' => true,
+        'no_superfluous_phpdoc_tags' => true,
+        'no_unneeded_control_parentheses' => true,
+        'no_unused_imports' => true,
+        'no_useless_return' => true,
+        'no_whitespace_before_comma_in_array' => true,
+        'object_operator_without_whitespace' => true,
+        'ordered_imports' => ['sort_algorithm' => 'alpha'],
+        'phpdoc_indent' => true,
+        'phpdoc_no_empty_return' => true,
+        'phpdoc_single_line_var_spacing' => true,
+        'return_assignment' => true,
+        'semicolon_after_instruction' => true,
+        'single_class_element_per_statement' => true,
+        'single_space_around_construct' => true,
+        'space_after_semicolon' => true,
+        'standardize_not_equals' => true,
+        'trim_array_spaces' => true,
+        'type_declaration_spaces' => true,
+        'types_spaces' => true,
+        'whitespace_after_comma_in_array' => ['ensure_single_space' => true],
+    ])
+    ->setFinder($finder);

composer.json

@@ -20,6 +20,7 @@
         "php": ">=8.2"
     },
     "require-dev": {
+        "friendsofphp/php-cs-fixer": "^3.75",
         "ircmaxell/php-yacc": "dev-master",
         "jbboehr/handlebars-spec": "dev-master",
         "phpstan/phpstan": "^2.1.14",
@@ -37,6 +38,7 @@
     },
     "scripts": {
         "analyze": "phpstan analyze",
+        "cs-fix": "php-cs-fixer fix -v",
         "test": "vendor/bin/phpunit tests"
     },
     "config": {