Add linting to pipeline

Author: marijnvanwezel

.github/workflows/main.yml

@@ -9,7 +9,7 @@ on:
 
 jobs:
   unit:
-    name: "Unit and mutation tests for PHP ${{ matrix.php-version }}"
+    name: "Unit and mutation testing"
     runs-on: ${{ matrix.os }}
     continue-on-error: true
 
@@ -35,24 +35,19 @@ jobs:
           ini-values: memory_limit=512M, xdebug.mode=off
           tools: composer:${{ env.COMPOSER_VERSION }}
 
-      - name: Get composer cache directory
+      - name: Get Composer cache directory
         id: composer-cache
         run: echo "::set-output name=dir::$(composer config cache-files-dir)"
 
-      - name: Cache dependencies
+      - name: Restore Composer cache
         uses: actions/cache@v2
         with:
           path: ${{ steps.composer-cache.outputs.dir }}
           key: composer-${{ runner.os }}-${{ matrix.php-version }}-${{ hashFiles('composer.*') }}
-          restore-keys: |
-            composer-${{ runner.os }}-${{ matrix.php-version }}-${{ hashFiles('composer.*') }}-
-            composer-${{ runner.os }}-${{ matrix.php-version }}-
-            composer-${{ runner.os }}-
-            composer-
+          restore-keys: composer-${{ runner.os }}-${{ matrix.php-version }}-
 
       - name: Install dependencies
-        run: |
-          composer install --no-interaction --prefer-dist --no-progress
+        run: composer install --no-interaction --prefer-dist --no-progress
 
       - name: Run unit tests
         run: |
@@ -61,3 +56,44 @@ jobs:
 
       - name: Run mutation tests
         run: XDEBUG_MODE=coverage php vendor/bin/infection --show-mutations --min-msi=${{ env.MINIMUM_MSI_PERCENTAGE }} --threads=4
+
+  lint:
+    name: "Linting"
+    runs-on: ${{ matrix.os }}
+    continue-on-error: true
+
+    strategy:
+      matrix:
+        os: [ "ubuntu-latest" ]
+        php-version: [ "8.1" ]
+
+    env:
+      COMPOSER_VERSION: 2
+      PHP_CS_FIXER_CACHE_FILE: .php-cs-fixer.cache
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+
+      - name: Get Composer cache directory
+        id: composer-cache
+        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+
+      - name: Restore Composer cache
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: composer-${{ runner.os }}-${{ matrix.php-version }}-${{ hashFiles('composer.*') }}
+          restore-keys: composer-${{ runner.os }}-${{ matrix.php-version }}-
+
+      - name: Install dependencies
+        run: |
+          composer install --no-interaction --prefer-dist --no-progress
+
+      - name: Run PHP-CS-Fixer
+        run: php vendor/bin/php-cs-fixer fix --config .php-cs-fixer.dist.php --verbose --dry-run

.php-cs-fixer.dist.php

@@ -0,0 +1,66 @@
+<?php
+
+use PhpCsFixer\Config;
+use PhpCsFixer\Finder;
+
+$finder = Finder::create()
+	->in([__DIR__ . '/src', __DIR__ . '/tests'])
+	->name('*php');
+
+return (new Config())
+	->setRules([
+		'@PSR12' => true,
+		'align_multiline_comment' => true,
+		'array_indentation' => true,
+		'blank_line_before_statement' => [
+			'statements' => [
+				'break',
+				'continue',
+				'declare',
+				'do',
+				'for',
+				'foreach',
+				'if',
+				'include',
+				'include_once',
+				'require',
+				'require_once',
+				'return',
+				'switch',
+				'throw',
+				'try',
+				'while',
+				'yield',
+			],
+		],
+		'concat_space' => ['spacing' => 'one'],
+		'fully_qualified_strict_types' => true,
+		'list_syntax' => [
+			'syntax' => 'short',
+		],
+		'no_unused_imports' => true,
+		'no_useless_else' => true,
+		'no_useless_return' => true,
+		'nullable_type_declaration_for_default_null_value' => true,
+		'ordered_class_elements' => true,
+		'ordered_imports' => true,
+		'phpdoc_align' => [
+			'align' => 'left',
+		],
+		'phpdoc_scalar' => true,
+		'php_unit_method_casing' => [
+			'case' => 'snake_case',
+		],
+		'phpdoc_order_by_value' => [
+			'annotations' => ['covers'],
+		],
+		'phpdoc_no_empty_return' => true,
+		'phpdoc_order' => true,
+		'return_assignment' => true,
+		'self_static_accessor' => true,
+		'simplified_if_return' => true,
+		'trailing_comma_in_multiline' => true
+	])
+	->setFinder($finder)
+	->setCacheFile(__DIR__ . '/.php-cs-fixer.cache')
+	->setUsingCache(true);

composer.json

@@ -71,6 +71,9 @@
       "infection/extension-installer": true
     }
   },
+  "scripts": {
+    "php-cs-fixer": "php-cs-fixer fix --config .php-cs-fixer.dist.php --verbose"
+  },
   "minimum-stability": "stable",
   "prefer-stable": true
 }