Merge pull request #27 from codeigniter4/psalm

Psalm

Author: MGatner

README.md

@@ -16,7 +16,8 @@ Development toolkit for CodeIgniter libraries and projects
 
 * [NexusPHP Tachycardia](https://github.com/NexusPHP/tachycardia)
 * [PHPStan](https://phpstan.org/user-guide/getting-started)
-* [PHPUnit](http://phpunit.readthedocs.io)
+* [PHPUnit](https://phpunit.readthedocs.io)
+* [Psalm](https://psalm.dev)
 
 ### Mocking
 

composer.json

@@ -32,7 +32,8 @@
         "phpstan/phpstan-deprecation-rules": "^1.0",
         "phpstan/phpstan-phpunit": "^1.0",
         "phpunit/phpunit": "^9.3",
-        "roave/security-advisories": "dev-latest"
+        "roave/security-advisories": "dev-latest",
+        "vimeo/psalm": "^4.22"
     },
     "minimum-stability": "dev",
     "prefer-stable": true,

psalm.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0"?>
+<psalm
+    errorLevel="7"
+    resolveFromConfigFile="true"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns="https://getpsalm.org/schema/config"
+    xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+    autoloader="psalm_autoload.php"
+    cacheDirectory="build/psalm/"
+>
+    <projectFiles>
+        <directory name="app/" />
+        <directory name="tests/" />
+        <ignoreFiles>
+            <directory name="vendor" />
+            <directory name="app/Views" />
+        </ignoreFiles>
+    </projectFiles>
+</psalm>

src/Template/.github/workflows/psalm.yml

@@ -0,0 +1,71 @@
+name: Psalm
+
+on:
+  pull_request:
+    branches:
+      - develop
+    paths:
+      - '**.php'
+      - 'composer.*'
+      - 'psalm*'
+      - '.github/workflows/psalm.yml'
+  push:
+    branches:
+      - develop
+    paths:
+      - '**.php'
+      - 'composer.*'
+      - 'psalm*'
+      - '.github/workflows/psalm.yml'
+
+jobs:
+  build:
+    name: Psalm Analysis
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, '[ci skip]')"
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.0'
+          tools: phpstan, phpunit
+          extensions: intl, json, mbstring, xml
+          coverage: none
+        env:
+          COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Get composer cache directory
+        id: composer-cache
+        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+
+      - name: Cache composer dependencies
+        uses: actions/cache@v3
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}-${{ hashFiles('**/composer.lock') }}
+          restore-keys: ${{ runner.os }}-composer-
+
+      - name: Create Psalm cache directory
+        run: mkdir -p build/psalm
+
+      - name: Cache Psalm results
+        uses: actions/cache@v3
+        with:
+          path: build/psalm
+          key: ${{ runner.os }}-psalm-${{ github.sha }}
+          restore-keys: ${{ runner.os }}-psalm-
+
+      - name: Install dependencies
+        run: |
+          if [ -f composer.lock ]; then
+            composer install --no-progress --no-interaction --prefer-dist --optimize-autoloader
+          else
+            composer update --no-progress --no-interaction --prefer-dist --optimize-autoloader
+          fi
+
+      - name: Run Psalm analysis
+        run: vendor/bin/psalm

src/Template/psalm.xml

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+require __DIR__ . '/vendor/codeigniter4/framework/system/Test/bootstrap.php';
+
+$helperDirs = [
+    'app/Helpers',
+    'vendor/codeigniter4/framework/system/Helpers',
+];
+
+foreach ($helperDirs as $dir) {
+    $dir = __DIR__ . '/' . $dir;
+    chdir($dir);
+
+    foreach (glob('*_helper.php') as $filename) {
+        $filePath = realpath($dir . '/' . $filename);
+
+        require_once $filePath;
+    }
+}