Enforce PSR-12 and organise imports on Winter CMS core files

.gitattributes

@@ -8,3 +8,4 @@
 .gitattributes export-ignore
 CHANGELOG.md export-ignore
 /package.json export-ignore
+phpcs.xml export-ignore

.github/workflows/code-quality.yaml

@@ -20,7 +20,7 @@ jobs:
           access_token: ${{ github.token }}
 
       - name: Checkout changes
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
@@ -29,7 +29,14 @@ jobs:
         with:
           php-version: 8.2
           extensions: curl, fileinfo, gd, mbstring, openssl, pdo, pdo_sqlite, sqlite3, xml, zip
-          tools: phpcs
+
+      - name: Install Composer dependencies
+        run: composer install --no-interaction --no-progress --no-scripts
+
+      - name: Reset modules
+        run: |
+          git reset --hard
+          git clean -fd
 
       - name: Run code quality checks (on push)
         if: github.event_name == 'push'
@@ -43,7 +50,7 @@ jobs:
     name: JavaScript
     steps:
       - name: Checkout changes
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
             fetch-depth: 0
 

.github/workflows/tests.yml

@@ -7,6 +7,10 @@ on:
       - develop
   pull_request:
 
+concurrency:
+  group: phpunit-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   frontendTests:
     strategy:
@@ -28,22 +32,7 @@ jobs:
           access_token: ${{ github.token }}
 
       - name: Checkout changes
-        uses: actions/checkout@v3
-
-      - name: Setup extension cache
-        id: extcache
-        uses: shivammathur/cache-extensions@v1
-        with:
-          php-version: ${{ env.phpVersion }}
-          extensions: ${{ env.extensions }}
-          key: ${{ env.key }}
-
-      - name: Cache extensions
-        uses: actions/cache@v3
-        with:
-          path: ${{ steps.extcache.outputs.dir }}
-          key: ${{ steps.extcache.outputs.key }}
-          restore-keys: ${{ steps.extcache.outputs.key }}
+        uses: actions/checkout@v4
 
       - name: Install PHP
         uses: shivammathur/setup-php@v2
@@ -64,17 +53,6 @@ jobs:
         if: github.head_ref == '1.2' || github.ref == 'refs/heads/1.2' || github.base_ref == '1.2'
         run: php ./.github/workflows/utilities/library-switcher "1.2.x-dev as 1.2"
 
-      - name: Setup dependency cache
-        id: composercache
-        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
-
-      - name: Cache dependencies
-        uses: actions/cache@v3
-        with:
-          path: ${{ steps.composercache.outputs.dir }}
-          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
-          restore-keys: ${{ runner.os }}-composer-
-
       - name: Install Composer dependencies
         run: composer install --no-interaction --no-progress --no-scripts
 
@@ -104,28 +82,8 @@ jobs:
       extensions: curl, fileinfo, gd, mbstring, openssl, pdo, pdo_sqlite, sqlite3, xml, zip
       key: winter-cms-cache-develop
     steps:
-      - name: Cancel previous incomplete runs
-        uses: styfle/cancel-workflow-action@0.8.0
-        with:
-          access_token: ${{ github.token }}
-
       - name: Checkout changes
-        uses: actions/checkout@v2
-
-      - name: Setup extension cache
-        id: extcache
-        uses: shivammathur/cache-extensions@v1
-        with:
-          php-version: ${{ matrix.phpVersion }}
-          extensions: ${{ env.extensions }}
-          key: ${{ env.key }}
-
-      - name: Cache extensions
-        uses: actions/cache@v3
-        with:
-          path: ${{ steps.extcache.outputs.dir }}
-          key: ${{ steps.extcache.outputs.key }}
-          restore-keys: ${{ steps.extcache.outputs.key }}
+        uses: actions/checkout@v4
 
       - name: Install PHP
         uses: shivammathur/setup-php@v2
@@ -149,17 +107,6 @@ jobs:
         if: github.head_ref == '1.2' || github.ref == 'refs/heads/1.2' || github.base_ref == '1.2'
         run: php ./.github/workflows/utilities/library-switcher "1.2.x-dev as 1.2"
 
-      - name: Setup dependency cache
-        id: composercache
-        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
-
-      - name: Cache dependencies
-        uses: actions/cache@v3
-        with:
-          path: ${{ steps.composercache.outputs.dir }}
-          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
-          restore-keys: ${{ runner.os }}-composer-
-
       - name: Install Composer dependencies
         run: composer install --no-interaction --no-progress --no-scripts
 

.github/workflows/utilities/phpcs-pr

@@ -30,7 +30,7 @@ if (!count($files)) {
 }
 
 // Run all changed files through the PHPCS code sniffer and generate a CSV report
-$csv = shell_exec('phpcs --colors -nq --report="csv" --extensions="php" ' . implode(' ', $files));
+$csv = shell_exec('./vendor/bin/phpcs --colors -nq --report="csv" --extensions="php" ' . implode(' ', $files));
 $lines = array_map(function ($row) {
     return array_map(function ($column) {
         return trim($column, '"');

.github/workflows/utilities/phpcs-push

@@ -30,7 +30,7 @@ if (!count($files)) {
 }
 
 // Run all changed files through the PHPCS code sniffer and generate a CSV report
-$csv = shell_exec('phpcs --colors -nq --report="csv" --extensions="php" ' . implode(' ', $files));
+$csv = shell_exec('./vendor/bin/phpcs --colors -nq --report="csv" --extensions="php" ' . implode(' ', $files));
 $lines = array_map(function ($row) {
     return array_map(function ($column) {
         return trim($column, '"');

bootstrap/app.php

@@ -12,7 +12,7 @@
 */
 
 $app = new Winter\Storm\Foundation\Application(
-    realpath(__DIR__.'/../')
+    realpath(__DIR__ . '/../')
 );
 
 /*

bootstrap/autoload.php

@@ -13,10 +13,10 @@
 |
 */
 
-$helperPath = __DIR__.'/../vendor/winter/storm/src/Support/helpers.php';
+$helperPath = __DIR__ . '/../vendor/winter/storm/src/Support/helpers.php';
 
 if (!file_exists($helperPath)) {
-    echo 'Missing vendor files, try running "composer install" or use the Wizard installer.'.PHP_EOL;
+    echo 'Missing vendor files, try running "composer install" or use the Wizard installer.' . PHP_EOL;
     exit(1);
 }
 
@@ -34,4 +34,4 @@
 |
 */
 
-require __DIR__.'/../vendor/autoload.php';
+require __DIR__ . '/../vendor/autoload.php';

composer.json

@@ -42,6 +42,7 @@
         "mockery/mockery": "^1.4.4",
         "fakerphp/faker": "^1.9.2",
         "squizlabs/php_codesniffer": "^3.2",
+        "slevomat/coding-standard": "^8.15.0",
         "php-parallel-lint/php-parallel-lint": "^1.0",
         "dms/phpunit-arraysubset-asserts": "^0.1.0|^0.2.1"
     },
@@ -56,13 +57,13 @@
             "@php artisan package:discover"
         ],
         "test": [
-            "phpunit --stop-on-failure"
+            "@php artisan test -- --stop-on-failure"
         ],
         "lint": [
             "parallel-lint --exclude vendor --exclude storage --exclude modules/system/tests/fixtures/plugins/testvendor/goto/Plugin.php ."
         ],
         "sniff": [
-            "phpcs --colors -nq --report=\"full\" --extensions=\"php\""
+            "@php artisan sniff"
         ]
     },
     "minimum-stability": "dev",
@@ -81,7 +82,8 @@
     "config": {
         "allow-plugins": {
             "composer/installers": true,
-            "wikimedia/composer-merge-plugin": true
+            "wikimedia/composer-merge-plugin": true,
+            "dealerdirect/phpcodesniffer-composer-installer": true
         }
     }
 }

modules/backend/ServiceProvider.php

@@ -1,4 +1,6 @@
-<?php namespace Backend;
+<?php
+
+namespace Backend;
 
 use Backend\Classes\WidgetManager;
 use Backend\Facades\Backend;
@@ -124,16 +126,16 @@ protected function registerBackendNavigation()
                     'iconSvg'     => 'modules/backend/assets/images/dashboard-icon.svg',
                     'url'         => Backend::url('backend'),
                     'permissions' => ['backend.access_dashboard'],
-                    'order'       => 10
+                    'order'       => 10,
                 ],
                 'media' => [
                     'label'       => 'backend::lang.media.menu_label',
                     'icon'        => 'icon-folder',
                     'iconSvg'     => 'modules/backend/assets/images/media-icon.svg',
                     'url'         => Backend::url('backend/media'),
                     'permissions' => ['media.*'],
-                    'order'       => 200
-                ]
+                    'order'       => 200,
+                ],
             ]);
             $manager->registerOwnerAlias('Winter.Backend', 'October.Backend');
         });
@@ -147,7 +149,7 @@ protected function registerBackendReportWidgets()
         WidgetManager::instance()->registerReportWidgets(function ($manager) {
             $manager->registerReportWidget(\Backend\ReportWidgets\Welcome::class, [
                 'label'   => 'backend::lang.dashboard.welcome.widget_title_default',
-                'context' => 'dashboard'
+                'context' => 'dashboard',
             ]);
         });
     }
@@ -277,7 +279,7 @@ protected function registerBackendSettings()
                     'class'       => 'Backend\Models\BrandSetting',
                     'permissions' => ['backend.manage_branding'],
                     'order'       => 500,
-                    'keywords'    => 'brand style'
+                    'keywords'    => 'brand style',
                 ],
                 'editor' => [
                     'label'       => 'backend::lang.editor.menu_label',
@@ -287,7 +289,7 @@ protected function registerBackendSettings()
                     'class'       => 'Backend\Models\EditorSetting',
                     'permissions' => ['backend.manage_editor'],
                     'order'       => 500,
-                    'keywords'    => 'html code class style'
+                    'keywords'    => 'html code class style',
                 ],
                 'myaccount' => [
                     'label'       => 'backend::lang.myaccount.menu_label',
@@ -297,7 +299,7 @@ protected function registerBackendSettings()
                     'url'         => Backend::url('backend/users/myaccount'),
                     'order'       => 500,
                     'context'     => 'mysettings',
-                    'keywords'    => 'backend::lang.myaccount.menu_keywords'
+                    'keywords'    => 'backend::lang.myaccount.menu_keywords',
                 ],
                 'preferences' => [
                     'label'       => 'backend::lang.backend_preferences.menu_label',
@@ -307,7 +309,7 @@ protected function registerBackendSettings()
                     'url'         => Backend::url('backend/preferences'),
                     'permissions' => ['backend.manage_preferences'],
                     'order'       => 510,
-                    'context'     => 'mysettings'
+                    'context'     => 'mysettings',
                 ],
                 'access_logs' => [
                     'label'       => 'backend::lang.access_log.menu_label',
@@ -316,8 +318,8 @@ protected function registerBackendSettings()
                     'icon'        => 'icon-lock',
                     'url'         => Backend::url('backend/accesslogs'),
                     'permissions' => ['system.access_logs'],
-                    'order'       => 920
-                ]
+                    'order'       => 920,
+                ],
             ]);
             $manager->registerOwnerAlias('Winter.Backend', 'October.Backend');
         });