Merge pull request #4 from OnrampLab/3-add-static-analysis-with-phpstan-and-phpcs

feat: Add static analysis tools (PHPStan and PHPCS)

Author: FishChen1202

.github/workflows/phpcs.yaml

@@ -0,0 +1,38 @@
+name: PHPCS
+
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+
+jobs:
+  phpcs:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Set up PHP
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: '8.1'
+
+    - name: Install dependencies
+      run: composer install
+
+    - name: Get list of changed files
+      id: changed-files
+      uses: tj-actions/changed-files@v34
+
+    - name: Run PHPCS
+      run: |
+        CHANGED_FILES=$(echo "${{ steps.changed-files.outputs.all_changed_files }}" | tr ' ' '\n' | grep '\.php$' || true)
+        if [ -n "$CHANGED_FILES" ]; then
+          vendor/bin/phpcs --standard=PSR12 $CHANGED_FILES
+        else
+          echo "No PHP files changed, skipping PHPCS."
+        fi

.github/workflows/phpstan.yaml

@@ -0,0 +1,38 @@
+name: PHPStan
+
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+
+jobs:
+  phpstan:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Set up PHP
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: '8.1'
+
+    - name: Install dependencies
+      run: composer install
+
+    - name: Get list of changed files
+      id: changed-files
+      uses: tj-actions/changed-files@v34
+
+    - name: Run PHPStan
+      run: |
+        CHANGED_FILES=$(echo "${{ steps.changed-files.outputs.all_changed_files }}" | tr ' ' '\n' | grep '\.php$' || true)
+        if [ -n "$CHANGED_FILES" ]; then
+          vendor/bin/phpstan analyse $CHANGED_FILES
+        else
+          echo "No PHP files changed, skipping PHPStan."
+        fi

composer.json

@@ -3,7 +3,7 @@
     "description": "A content generator for PHP",
     "type": "library",
     "require": {
-        "php": ">=7.4",
+        "php": ">=8.1",
         "mustache/mustache": "^2.13"
     },
     "autoload": {
@@ -12,7 +12,9 @@
         }
     },
     "require-dev": {
-        "phpunit/phpunit": "^9.5"
+        "phpunit/phpunit": "^9.5",
+        "phpstan/phpstan": "^1.0",
+        "squizlabs/php_codesniffer": "^3.0"
     },
     "scripts": {
         "test": "phpunit"

composer.lock

@@ -0,0 +1,10 @@
+parameters:
+    level: max
+    paths:
+        - src
+
+    # Optional: Include bootstrap file if necessary and ensure the path is correct
+    bootstrapFiles:
+        - vendor/autoload.php
+
+    # Optional: Add any other configuration options as needed