Merge pull request #49 from roberto-butti/feature/composer-run

composer run for launching code quality

.gitignore

@@ -3,3 +3,4 @@
 .git
 .phpunit.result.cache
 .phpunit.result.cache
+.php-cs-fixer.cache

.php-cs-fixer.php

@@ -1,6 +1,12 @@
 <?php
 
-$finder = PhpCsFixer\Finder::create();
+$finder = PhpCsFixer\Finder::create()
+    ->in([
+        __DIR__ . '/src',
+    ])
+    ->name('*.php')
+    ->ignoreDotFiles(true)
+    ->ignoreVCS(true);
 
 $config = new PhpCsFixer\Config();
 $config->setRiskyAllowed(true);

README.md

@@ -267,6 +267,21 @@ When using the CDN API V1, you can't resolve relationships of resolved entries a
 When using the CDN API V2 you can resolve also nested relationships in the resolved entries (just 2 levels deep), but the resolved entries are not injected in the fields, they are inserted in an array called `rels` which is in the root object. The resolved links will be placed in an array called `links`.
 In case you are using the API V2, to keep a consistent behaviour with the API V1, this client will inject the resolved entries and links inside the fields for you.
 
+## Code Quality
+
+The package includes tools for tests and code formatting:
+- [PestPHP](https://pestphp.com/)
+- [PHP CS Fixer](https://cs.symfony.com/)
+To execute the code quality suite you can use:
+```shell
+composer run all-check
+```
+that executes:
+- vendor/bin/php-cs-fixer fix
+- vendor/bin/pest
+
+
+
 ## 🔗 Related Links
 
 * **[Storyblok & PHP on GitHub](https://github.com/search?q=org%3Astoryblok+topic%3Aphp)**:  Check all of our PHP open source repos;

composer.json

@@ -41,5 +41,14 @@
         "allow-plugins": {
             "pestphp/pest-plugin": true
         }
+    },
+    "scripts": {
+        "test": "vendor/bin/pest",
+        "test-coverage": "vendor/bin/pest --coverage",
+        "format": "vendor/bin/php-cs-fixer fix --allow-risky=yes",
+        "all-check": [
+            "@format",
+            "@test"
+        ]
     }
 }