chore(*): add documentation + fix phpstan

# Conflicts:
#	src/PhpinsightsFormatterServiceProvider.php

Author: ElRochito

.php-cs-fixer.dist.php

@@ -1,8 +1,6 @@
 <?php declare(strict_types=1);
 
 $finder = PhpCsFixer\Finder::create()->in([
-    'config',
-    'database',
     'src',
     'tests',
 ]);

README.md

@@ -1,12 +1,14 @@
-# Provides formatters for Phpinsights
+![alt text](https://soyhuce.fr/wp-content/uploads/2020/06/logo-soyhuce-dark-1.png "Soyhuce")
+
+# PhpInsights formatters
 
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/soyhuce/phpinsights-formatter.svg?style=flat-square)](https://packagist.org/packages/soyhuce/phpinsights-formatter)
 [![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/soyhuce/phpinsights-formatter/run-tests?label=tests)](https://github.com/soyhuce/phpinsights-formatter/actions?query=workflow%3Arun-tests+branch%3Amain)
 [![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/soyhuce/phpinsights-formatter/Check%20&%20fix%20styling?label=code%20style)](https://github.com/soyhuce/phpinsights-formatter/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
 [![GitHub PHPStan Action Status](https://img.shields.io/github/workflow/status/soyhuce/phpinsights-formatter/PHPStan?label=phpstan)](https://github.com/soyhuce/phpinsights-formatter/actions?query=workflow%3APHPStan+branch%3Amain)
 [![Total Downloads](https://img.shields.io/packagist/dt/soyhuce/phpinsights-formatter.svg?style=flat-square)](https://packagist.org/packages/soyhuce/phpinsights-formatter)
 
-This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
+Ce package permet l'ajout de formatters pour [PhpInsights](https://phpinsights.com/)
 
 ## Installation
 
@@ -16,44 +18,30 @@ You can install the package via composer:
 composer require soyhuce/phpinsights-formatter
 ```
 
-You can publish and run the migrations with:
+### Text Formatter
 
+Utilisez le formatter via
 ```bash
-php artisan vendor:publish --tag="phpinsights-formatter-migrations"
-php artisan migrate
+php artisan insights --format=\\Soyhuce\\PhpInsights\\TextFormatter > insights.txt
 ```
 
-You can publish the config file with:
+### Markdown Formatter
 
+Utilisez le formatter via
 ```bash
-php artisan vendor:publish --tag="phpinsights-formatter-config"
+php artisan insights --format=\\Soyhuce\\PhpInsights\\MarkdownFormatter
 ```
 
-This is the contents of the published config file:
-
-```php
-return [
-];
-```
+Le résultat sera stocké sous `insights-full.md`
 
-Optionally, you can publish the views using
+### Light Markdown Formatter
 
+Utilisez le formatter via
 ```bash
-php artisan vendor:publish --tag="phpinsights-formatter-views"
+php artisan insights --format=\\Soyhuce\\PhpInsights\\LightMarkdownFormatter
 ```
 
-## Usage
-
-```php
-$phpinsightsFormatter = new Soyhuce\PhpinsightsFormatter();
-echo $phpinsightsFormatter->echoPhrase('Hello, Soyhuce!');
-```
-
-## Testing
-
-```bash
-composer test
-```
+Le résultat sera stocké sous `insights.md`
 
 ## Changelog
 

composer.json

@@ -4,7 +4,7 @@
     "keywords": [
         "Soyhuce",
         "laravel",
-        "phpinsights-formatter"
+        "phpinsights"
     ],
     "homepage": "https://github.com/soyhuce/phpinsights-formatter",
     "license": "MIT",
@@ -17,8 +17,7 @@
     ],
     "require": {
         "php": "^8.1",
-        "spatie/laravel-package-tools": "^1.9.2",
-        "illuminate/contracts": "^9.0"
+        "nunomaduro/phpinsights": "^2.3"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^3.7",
@@ -34,13 +33,7 @@
     },
     "autoload": {
         "psr-4": {
-            "Soyhuce\\PhpinsightsFormatter\\": "src",
-            "Soyhuce\\PhpinsightsFormatter\\Database\\Factories\\": "database/factories"
-        }
-    },
-    "autoload-dev": {
-        "psr-4": {
-            "Soyhuce\\PhpinsightsFormatter\\Tests\\": "tests"
+            "Soyhuce\\PhpInsights\\": "src"
         }
     },
     "scripts": {
@@ -58,17 +51,8 @@
         "sort-packages": true,
         "allow-plugins": {
             "pestphp/pest-plugin": true,
-            "phpstan/extension-installer": true
-        }
-    },
-    "extra": {
-        "laravel": {
-            "providers": [
-                "Soyhuce\\PhpinsightsFormatter\\PhpinsightsFormatterServiceProvider"
-            ],
-            "aliases": {
-                "PhpinsightsFormatter": "Soyhuce\\PhpinsightsFormatter\\Facades\\PhpinsightsFormatter"
-            }
+            "phpstan/extension-installer": true,
+            "dealerdirect/phpcodesniffer-composer-installer": true
         }
     },
     "minimum-stability": "dev",

config/phpinsights-formatter.php

@@ -0,0 +1,13 @@
+parameters:
+  ignoreErrors:
+    - message: "#^Offset string on array\\{\\} on left side of \\?\\?\\= does not exist\\.$#"
+      count: 1
+      path: src/MarkdownFormatter.php
+
+    - message: "#^Parameter \\#1 \\$path of function realpath expects string, string\\|false given\\.$#"
+      count: 1
+      path: src/MarkdownFormatter.php
+
+    - message: "#^Parameter \\#1 \\$path of function realpath expects string, string\\|false given\\.$#"
+      count: 1
+      path: src/TextFormatter.php

database/factories/ModelFactory.php

@@ -5,8 +5,6 @@ parameters:
     level: 8
     paths:
         - src
-        - config
-        - database
     checkOctaneCompatibility: true
     checkModelProperties: true
     checkMissingIterableValueType: true