update readme and add tests

.github/workflows/ci.yml

@@ -1,21 +1,49 @@
 name: CI
 
-on: ['push', 'pull_request']
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
 
 jobs:
   pest:
     runs-on: ubuntu-latest
-    container:
-      image: kirschbaumdevelopment/laravel-test-runner:8.3
-
+    strategy:
+      fail-fast: false
+      matrix:
+        php: ['8.3', '8.4', '8.5']
+    name: Pest (PHP ${{ matrix.php }})
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v4
+
+      - uses: shivammathur/setup-php@v2
         with:
-          fetch-depth: 1
+          php-version: ${{ matrix.php }}
+          coverage: none
 
       - name: Install composer dependencies
-        run: |
-          composer install --no-scripts
+        run: composer install --no-interaction --prefer-dist
 
       - name: Run Testsuite
-        run: vendor/bin/pest
+        run: vendor/bin/pest
+
+  quality:
+    runs-on: ubuntu-latest
+    name: Quality (PHPStan + Pint)
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.3'
+          coverage: none
+
+      - name: Install composer dependencies
+        run: composer install --no-interaction --prefer-dist
+
+      - name: Run PHPStan
+        run: vendor/bin/phpstan analyse
+
+      - name: Run Pint
+        run: vendor/bin/pint --test

README.md

@@ -12,7 +12,7 @@
 ## 👋 Introduction
 This package allows FakerPHP to generate fake IDs which have the same structure you can expect to be returned from 
 Stripe. The wonderful [Pest](https://pestphp.com/) is used to run tests contained within this package, which requires
-a minimum PHP Version of 8.2. 
+a minimum PHP Version of 8.3. 
 
 This package is listed on the [official FakerPHP website](https://fakerphp.org/third-party/) as a third party library.
 

composer.json

@@ -17,7 +17,9 @@
     },
     "require-dev": {
         "pestphp/pest": "^v4.0",
-        "pestphp/pest-plugin-faker": "^v4.0"
+        "pestphp/pest-plugin-faker": "^v4.0",
+        "phpstan/phpstan": "^2.2",
+        "laravel/pint": "^1.30"
     },
     "autoload": {
         "psr-4": {
@@ -33,5 +35,11 @@
         "allow-plugins": {
             "pestphp/pest-plugin": true
         }
+    },
+    "scripts": {
+        "test": "pest",
+        "phpstan": "phpstan analyse",
+        "pint": "pint",
+        "pint:test": "pint --test"
     }
 }

phpstan.neon

@@ -0,0 +1,4 @@
+parameters:
+    level: max
+    paths:
+        - src

pint.json

@@ -0,0 +1,3 @@
+{
+    "preset": "psr12"
+}

src/Stripe.php

@@ -4,7 +4,7 @@
 
 class Stripe extends Base
 {
-    private function generateRandomString($length = 24, $numericOnly = false): string
+    private function generateRandomString(int $length = 24, bool $numericOnly = false): string
     {
         if ($numericOnly) {
             $characters = '0123456789';

tests/ArchitectureTest.php

@@ -6,4 +6,4 @@
 test('provider')
     ->expect(Stripe::class)
     ->toExtend(Base::class)
-    ->toOnlyUse(Base::class);
+    ->toOnlyUse(Base::class);

tests/StripeTest.php

@@ -1,6 +1,7 @@
 <?php
 
 use Faker\Provider\Stripe;
+
 use function Pest\Faker\fake;
 
 beforeEach(function () {