Configure xdebug and PHPUnit settings

- Added xdebug configuration in `devops/xdebug.ini` for coverage, debugging, and development mode
- Updated PHPUnit settings in `phpunit.xml` to include coverage reports for the source directory
- Adjusted display errors settings in xdebug and PHPUnit configuration for better error handling and reporting.

Author: MikeGarde

.github/workflows/tests.yml

@@ -20,10 +20,19 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php }}
-          extensions: zip
+          extensions: zip, xdebug
+          coverage: xdebug
 
       - name: Install Dependencies
         run: composer install
 
       - name: Run tests
-        run: composer test
+        run: composer test:coverage
+
+      - name: Upload coverage reports to Codecov
+        if: ${{ matrix.php == '8.4' }}
+        uses: codecov/[email protected]
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          file: ./tmp/clover.xml
+

.gitignore

@@ -1,4 +1,5 @@
 /.idea/
+/tmp/
 /vendor/
 
 .phpunit.result.cache

Dockerfile

@@ -12,4 +12,7 @@ ADD https://github.com/mlocati/docker-php-extension-installer/releases/latest/do
 RUN chmod +x /usr/local/bin/install-php-extensions && sync
 RUN install-php-extensions @composer xdebug
 
+COPY devops/xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini
+RUN rm /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini
+
 WORKDIR /app

README.md

@@ -1,6 +1,7 @@
 # Laravel Route Docs
 
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/mikegarde/laravel-route-docs.svg?style=flat-square)](https://packagist.org/packages/mikegarde/laravel-route-docs)
+[![codecov](https://codecov.io/gh/mikegarde/laravel-route-docs/branch/main/graph/badge.svg)](https://codecov.io/gh/mikegarde/laravel-route-docs)
 [![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/mikegarde/laravel-route-docs/run-tests.yml?branch=main&label=tests)](https://github.com/mikegarde/laravel-route-docs/actions)
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](LICENSE)
 

composer.json

@@ -53,10 +53,19 @@
   ],
   "minimum-stability": "stable",
   "prefer-stable": true,
+  "config": {
+    "sort-packages": true
+  },
   "scripts": {
     "test": [
       "phpunit"
     ],
+    "test:coverage": [
+      "phpunit --coverage-clover=tmp/clover.xml"
+    ],
+    "test:report": [
+      "phpunit --coverage-html=tmp/coverage"
+    ],
     "post-autoload-dump": [
       "Illuminate\\Foundation\\ComposerScripts::postAutoloadDump"
     ]

devops/xdebug.ini

@@ -0,0 +1,10 @@
+zend_extension=xdebug.so
+
+[xdebug]
+xdebug.mode=coverage,debug,develop
+xdebug.client_host=host.docker.internal
+xdebug.idekey=PHPSTORM
+
+error_reporting = E_ALL & ~E_DEPRECATED & ~E_STRICT
+display_startup_errors = Off
+display_errors = Off