Merge pull request #666 from tighten/jbk/php-cs-fixer

Re-configure and run PHP-CS-Fixer

Author: bakerkretzmar

.editorconfig

@@ -1,6 +1,3 @@
-; This file is for unifying the coding style for different editors and IDEs.
-; More information at https://editorconfig.org
-
 root = true
 
 [*]
@@ -15,4 +12,4 @@ trim_trailing_whitespace = true
 trim_trailing_whitespace = false
 
 [*.yml]
-indent_size = 2
+indent_size = 2

.git-blame-ignore-revs

@@ -6,3 +6,9 @@
 
 # Move dotenv file snapshot test
 a2f33e083680337ba53704e4daf8c2d9ed2ac2f8
+
+# Format
+ec8c6c07e290fa3c85fd7a1975d1bee0f0d417b9
+
+# Format
+12148101ebd2a945d581bf17a7d3c7ed139250cb

.github/workflows/format.yml

@@ -0,0 +1,34 @@
+name: Format
+on:
+  pull_request:
+    paths: ['**.php']
+jobs:
+  php-cs-fixer:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          ref: ${{ github.event.pull_request.head.ref }}
+      - uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.1
+      - uses: ramsey/composer-install@v2
+      - name: Run PHP-CS-Fixer
+        id: format
+        # https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#multiline-strings
+        run: |
+          delimiter=$RANDOM
+          echo "summary<<${delimiter}" >> $GITHUB_OUTPUT
+          composer format >> $GITHUB_OUTPUT
+          echo $delimiter >> $GITHUB_OUTPUT
+      - name: Check for fixed files
+        run: echo "changed=$(git diff --quiet && echo false || echo true)" >> $GITHUB_ENV
+      - name: Commit changes
+        if: ${{ env.changed == 'true' }}
+        run: |
+          git config --global user.name github-actions
+          git config --global user.email github-actions[bot]@users.noreply.github.com
+          # awk trims leading and trailing whitespace from each line, sed removes the last two lines
+          git commit -a -m "Format" -m "$(echo '${{ steps.format.outputs.summary }})' | awk '{$1=$1};1' | sed '$d' | sed '$d')"
+          git push

.github/workflows/test.yml

@@ -4,7 +4,7 @@ on:
   push:
     branches: [main, ci]
 jobs:
-  test:
+  phpunit:
     name: PHP ${{ matrix.php }}, ${{ matrix.dependencies }}
     runs-on: ubuntu-latest
     continue-on-error: ${{ matrix.php == '8.2' }}

.gitignore

@@ -1,4 +1,4 @@
 vendor/
+.php-cs-fixer.cache
 .phpunit.result.cache
-.php_cs.cache
 composer.lock

.php-cs-fixer.php

@@ -0,0 +1,49 @@
+<?php
+
+return (new PhpCsFixer\Config)
+    ->setFinder(PhpCsFixer\Finder::create()->in(__DIR__)->exclude('tests/snapshots'))
+    ->setRiskyAllowed(true)
+    ->setRules([
+        '@PSR2' => true,
+        '@Symfony' => true,
+        'align_multiline_comment' => [
+            'comment_type' => 'all_multiline',
+        ],
+        'binary_operator_spaces' => [
+            'operators' => [
+                '|' => 'single_space', // Doesn't apply to union types
+            ],
+        ],
+        'blank_line_after_namespace' => true,
+        'blank_line_after_opening_tag' => true,
+        'blank_line_before_statement' => [
+            'statements' => ['return', 'throw'],
+        ],
+        'concat_space' => [
+            'spacing' => 'one',
+        ],
+        'get_class_to_class_keyword' => true,
+        'global_namespace_import' => [
+            'import_classes' => true,
+        ],
+        'new_with_braces' => false,
+        'no_empty_comment' => false,
+        'no_useless_else' => true,
+        'not_operator_with_successor_space' => true,
+        'php_unit_method_casing' => false,
+        'phpdoc_annotation_without_dot' => false,
+        'phpdoc_to_comment' => [
+            'ignored_tags' => ['var'],
+        ],
+        'phpdoc_separation' => [
+            'groups' => [
+                ['test', 'group', 'dataProvider', 'doesNotPerformAssertions'],
+            ],
+        ],
+        'phpdoc_var_annotation_correct_order' => true,
+        'trailing_comma_in_multiline' => [
+            'after_heredoc' => true,
+            'elements' => ['arrays', 'arguments', 'parameters'],
+        ],
+        'yoda_style' => false,
+    ]);