Merge pull request #13 from BoatraceOpenAPI/feature/issue-9-psalm

chore: add vimeo/psalm for static analysis

Author: shimomo

.github/workflows/psalm.yml

@@ -0,0 +1,37 @@
+name: psalm
+
+on:
+  push:
+    branches:
+      - '*.x'
+  pull_request:
+  schedule:
+    - cron: '0 0 * * *'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  psalm:
+    name: Psalm Static Analysis on PHP ${{ matrix.php-version }} (Ubuntu 24.04)
+    runs-on: ubuntu-24.04
+    strategy:
+      matrix:
+        php-version:
+          - '8.4'
+    steps:
+      - name: Setup PHP ${{ matrix.php-version }}
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          extensions: mbstring, xml
+
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Install Dependencies
+        run: composer install --prefer-dist --no-interaction --no-progress --dev
+
+      - name: Run Psalm
+        run: vendor/bin/psalm --show-info=true

composer.json

@@ -20,7 +20,8 @@
         "nesbot/carbon": "^2.63 || ^3.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^12.0"
+        "phpunit/phpunit": "^12.0",
+        "vimeo/psalm": "^6.0"
     },
     "autoload": {
         "psr-4": {

psalm.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<psalm
+    errorLevel="1"
+    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"
+    findUnusedBaselineEntry="true"
+    findUnusedCode="false"
+>
+    <projectFiles>
+        <directory name="src"/>
+        <ignoreFiles>
+            <directory name="vendor"/>
+        </ignoreFiles>
+    </projectFiles>
+
+    <stubs>
+        <file name="stubs/Scraper.stubphp"/>
+    </stubs>
+</psalm>

stubs/Scraper.stubphp

@@ -0,0 +1,5 @@
+<?php
+
+namespace BVP\Scraper;
+
+final class Scraper {}