Merge pull request #16 from laravel/feat/dev-tools

Add package quality tooling

Author: joetannenbaum

.github/dependabot.yml

@@ -0,0 +1,13 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directories:
+      - "/"
+    schedule:
+      interval: "weekly"
+    cooldown:
+      default-days: 5
+    groups:
+      github-actions:
+        patterns:
+          - "*"

.github/workflows/tests.yml

@@ -0,0 +1,53 @@
+name: tests
+
+on:
+  push:
+    branches:
+      - main
+      - 1.x
+      - 2.x
+  pull_request:
+    branches:
+      - main
+      - 1.x
+      - 2.x
+
+permissions:
+  contents: read
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        php-version: ['8.3', '8.4', '8.5']
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
+        with:
+          persist-credentials: false
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@f3e473d116dcccaddc5834248c87452386958240 # v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          tools: composer:v2
+          coverage: none
+
+      - name: Install Dependencies
+        run: composer install --no-interaction --prefer-dist --optimize-autoloader
+
+      - name: Run Static Analysis
+        run: composer analyse
+
+      - name: Run Lint Check
+        run: composer lint:check
+
+      - name: Run Type Coverage
+        run: composer test:types
+
+      - name: Run Unit Tests
+        run: composer test:unit

.gitignore

@@ -1 +1,2 @@
 vendor
+composer.lock

composer.json

@@ -28,10 +28,51 @@
             "src/functions.php"
         ]
     },
+    "autoload-dev": {
+        "psr-4": {
+            "Tests\\": "tests/"
+        }
+    },
     "require": {
-        "php": "^8.2"
+        "php": "^8.3"
+    },
+    "require-dev": {
+        "laravel/pao": "^1.1",
+        "laravel/pint": "^1.29",
+        "pestphp/pest": "^4.7",
+        "pestphp/pest-plugin-type-coverage": "^4.0",
+        "phpstan/phpstan": "^2.2"
     },
     "bin": [
         "cpx"
-    ]
+    ],
+    "scripts": {
+        "analyse": [
+            "phpstan analyse"
+        ],
+        "lint": [
+            "pint --parallel"
+        ],
+        "lint:check": [
+            "pint --parallel --test"
+        ],
+        "test:types": [
+            "pest --type-coverage --min=100"
+        ],
+        "test:unit": [
+            "pest --parallel"
+        ],
+        "test": [
+            "@analyse",
+            "@lint:check",
+            "@test:types",
+            "@test:unit"
+        ]
+    },
+    "config": {
+        "allow-plugins": {
+            "pestphp/pest-plugin": true
+        },
+        "sort-packages": true
+    }
 }

cpx

@@ -34,11 +34,6 @@ if (isset($GLOBALS['_composer_autoload_path'])) {
     unset($file);
 }
 
-function printColor(string $message, string $color = "\033[1;32m"): void
-{
-    echo $color . $message . "\033[0m" . PHP_EOL;
-}
-
 array_shift($argv);
 $console = Console::parse($argv ?? []);
 

files/psysh-config.php

@@ -1,7 +1,9 @@
 <?php
 
-require_once __DIR__ . '/../vendor/autoload.php';
+use Cpx\PhpExecutionHelper;
 
-Cpx\PhpExecutionHelper::init(getcwd());
+require_once __DIR__.'/../vendor/autoload.php';
+
+PhpExecutionHelper::init(getcwd());
 
 return [];

phpstan.neon.dist

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

phpunit.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+>
+    <testsuites>
+        <testsuite name="Test Suite">
+            <directory suffix="Test.php">./tests</directory>
+        </testsuite>
+    </testsuites>
+    <source>
+        <include>
+            <directory suffix=".php">src</directory>
+        </include>
+    </source>
+</phpunit>

pint.json

@@ -0,0 +1,27 @@
+{
+    "preset": "laravel",
+    "rules": {
+        "blank_line_before_statement": {
+            "statements": [
+                "break",
+                "continue",
+                "declare",
+                "if",
+                "return",
+                "throw",
+                "try"
+            ]
+        },
+        "global_namespace_import": {
+            "import_classes": true
+        },
+        "trailing_comma_in_multiline": {
+            "elements": [
+                "arguments",
+                "arrays",
+                "match",
+                "parameters"
+            ]
+        }
+    }
+}

src/ClassAliasAutoloader.php

@@ -1,14 +1,16 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Cpx;
 
-use RecursiveIteratorIterator;
 use RecursiveDirectoryIterator;
+use RecursiveIteratorIterator;
 use SplFileInfo;
 
 class ClassAliasAutoloader
 {
-    /** All of the discovered classes. */
+    /** @var array<string, string> */
     protected array $classes = [];
 
     public function __construct(
@@ -21,13 +23,13 @@ public function addAliases(string $autoloadRootDirectory): void
             $classes = require "{$autoloadRootDirectory}/vendor/composer/autoload_classmap.php";
 
             foreach ($classes as $class => $path) {
-                if (!str_contains($class, '\\')) {
+                if (! str_contains($class, '\\')) {
                     continue;
                 }
 
                 $name = basename(str_replace('\\', '/', $class));
 
-                if (!isset($this->classes[$name]) && class_exists($name)) {
+                if (! isset($this->classes[$name]) && class_exists($name)) {
                     $this->classes[$name] = $class;
                 }
             }
@@ -38,12 +40,12 @@ public function addAliases(string $autoloadRootDirectory): void
 
             foreach ($psr4 as $namespace => $directories) {
                 foreach ($directories as $directory) {
-                    if (!file_exists($directory)) {
+                    if (! file_exists($directory)) {
                         continue;
                     }
                     $iterator = new RecursiveIteratorIterator(
                         new RecursiveDirectoryIterator($directory),
-                        RecursiveIteratorIterator::LEAVES_ONLY
+                        RecursiveIteratorIterator::LEAVES_ONLY,
                     );
 
                     foreach ($iterator as $file) {
@@ -53,13 +55,12 @@ public function addAliases(string $autoloadRootDirectory): void
 
                             $relativePath = str_replace($directory, '', $file->getPath());
 
-                            if (!empty($relativePath)) {
-                                $classNamespace .= strtr($relativePath, DIRECTORY_SEPARATOR, '\\') . '\\';
+                            if (! empty($relativePath)) {
+                                $classNamespace .= strtr($relativePath, DIRECTORY_SEPARATOR, '\\').'\\';
                             }
 
                             $basename = $file->getBasename('.php');
-                            $class = str_replace('\\\\', '\\', $classNamespace . $basename);
-
+                            $class = str_replace('\\\\', '\\', $classNamespace.$basename);
 
                             if (str_ends_with($basename, 'Test')) {
                                 continue;