Format code with PHP-CS-Fixer

Author: theodorejb

.github/workflows/php.yml

@@ -55,3 +55,7 @@ jobs:
         run: composer test-without-mssql
         env:
           POSTGRES_HOST: localhost
+
+      - name: Check Formatting
+        run: vendor/bin/php-cs-fixer fix -v --dry-run --stop-on-violation --using-cache=no
+        if: ${{ matrix.php == '8.3' }}

.gitignore

@@ -1,5 +1,6 @@
 .idea
 .phpunit.result.cache
+.php-cs-fixer.cache
 
 /vendor/
 /composer.lock

.php-cs-fixer.php

@@ -0,0 +1,58 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()
+    ->path([
+        'lib/',
+        'test/',
+    ])
+    ->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 @@
         "ext-pdo": "*"
     },
     "require-dev": {
+        "friendsofphp/php-cs-fixer": "^3.64",
         "phpunit/phpunit": "^10.5",
         "psalm/plugin-phpunit": "^0.19",
         "ramsey/uuid": "^4.2.3",
@@ -40,6 +41,7 @@
     },
     "scripts": {
         "analyze": "psalm",
+        "cs-fix": "php-cs-fixer fix -v",
         "test": "phpunit",
         "test-mssql": "phpunit --exclude-group mysql,pgsql",
         "test-mysql": "phpunit --exclude-group mssql,pgsql",

lib/BulkInsertResult.php

@@ -17,6 +17,6 @@ class BulkInsertResult
     public function __construct(
         public readonly array $ids,
         public readonly int $affected,
-        public readonly int $queryCount = 1
+        public readonly int $queryCount = 1,
     ) {}
 }

lib/InsertResult.php

@@ -15,6 +15,6 @@ class InsertResult
      */
     public function __construct(
         public readonly int $id,
-        public readonly int $affected
+        public readonly int $affected,
     ) {}
 }

lib/QueryBuilder/Insert.php

@@ -24,7 +24,7 @@ public static function batchRows(array $colVals, int $maxBoundParams, int $maxRo
         }
 
         if ($maxBoundParams > 0) {
-            $maxRowsPerQuery = (int)floor($maxBoundParams / count($colVals[0])); // max bound params divided by params per row
+            $maxRowsPerQuery = (int) floor($maxBoundParams / count($colVals[0])); // max bound params divided by params per row
         }
 
         if ($maxRows > 0 && $maxRowsPerQuery > $maxRows) {

lib/SqlException.php

@@ -14,7 +14,8 @@ class SqlException extends \RuntimeException
      */
     private readonly string $sqlState;
 
-    public function __construct(string $message, int $code, string $details, string $sqlState) {
+    public function __construct(string $message, int $code, string $details, string $sqlState)
+    {
         if ($details !== '') {
             $message .= ": $details";
         }

test/DbTestCase.php

@@ -4,8 +4,8 @@
 
 namespace PeachySQL\Test;
 
-use PeachySQL\{PeachySql, SqlException};
 use PeachySQL\QueryBuilder\SqlParams;
+use PeachySQL\{PeachySql, SqlException};
 use PHPUnit\Framework\TestCase;
 use Ramsey\Uuid\Uuid;
 

test/QueryBuilder/InsertTest.php

@@ -21,19 +21,19 @@ public static function batchRowsTestCases(): array
         $colVals = [
             [
                 'column1' => 'test',
-                'column2' => 'test2'
+                'column2' => 'test2',
             ],
             [
                 'column1' => 'test3',
-                'column2' => 'test4'
+                'column2' => 'test4',
             ],
             [
                 'column1' => 'test5',
-                'column2' => 'test6'
+                'column2' => 'test6',
             ],
             [
                 'column1' => 'test7',
-                'column2' => 'test8'
+                'column2' => 'test8',
             ],
         ];