[Composer] Added one command to run them all (checks) (#3271)

* [Composer] Added one command to run them all (checks)

* Added YAML check

* Added regemerate baseline commands

* Added "fix" and "baseline" commands

* Run PHP-CS-Fixer on PHP 8.4

* Update composer.json

Co-authored-by: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com>

* Fix syntax error

* Fixed CS

* Add colors

---------

Co-authored-by: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com>

Author: mnocon

.github/workflows/code_samples.yaml

@@ -45,33 +45,11 @@ jobs:
               with:
                   dependency-versions: highest
 
-            - name: Run PHPStan analysis
+            - name: Run code sample quality tests
               id: phpstan
-              continue-on-error: true
-              run: composer phpstan
-
-            - name: Run Deptrac analysis
-              id: deptrac
-              continue-on-error: true
-              run: composer deptrac
-
-            - name: Run Rector check
-              id: rector
-              continue-on-error: true
-              run: composer check-rector
-
-            - name: Run YAML snippet tests
-              id: check-yaml
-              continue-on-error: true
-              run: composer check-yaml
-
-            - name: Fail job if any check failed
-              if: always()
-              run: |
-                  if [[ "${{ steps.phpstan.outcome }}" == "failure" || "${{ steps.deptrac.outcome }}" == "failure" || "${{ steps.rector.outcome }}" == "failure" || "${{ steps.check-yaml.outcome }}" == "failure" ]]; then
-                      echo "One or more checks failed: PHPStan=${{ steps.phpstan.outcome }}, Deptrac=${{ steps.deptrac.outcome }}, Rector=${{ steps.rector.outcome }}, YAML=${{ steps.check-yaml.outcome }}"
-                      exit 1
-                  fi
+              run: composer test --ansi
+              env:
+                  PHP_CS_FIXER_IGNORE_ENV: ${{ matrix.php == '8.4' && '1' || '' }}
 
 
     code-samples-inclusion-check:

README.md

@@ -87,8 +87,9 @@ composer phpstan
 ```
 
 Regenerate the baseline by running:
+
 ```bash
-composer phpstan -- --generate-baseline
+composer phpstan-update-baseline
 ```
 
 #### Skipping validation of inline PHP snippets
@@ -120,8 +121,9 @@ composer deptrac
 ```
 
 Regenerate the baseline by running:
+
 ```bash
-vendor/bin/deptrac --formatter=baseline
+composer deptrac-update-baseline
 ```
 
 ## Checking links

composer.json

@@ -123,7 +123,35 @@
         "check-rector": "php tools/extract-inline-php.php && rector process --dry-run --ansi",
         "check-yaml": "phpunit --group yaml",
         "phpunit": "phpunit --exclude-group=yaml",
-        "yaml-update-baseline": "php tests/generate-yaml-baseline.php"
+        "yaml-update-baseline": "php tests/generate-yaml-baseline.php",
+        "phpstan-update-baseline": "@phpstan --generate-baseline",
+        "deptrac-update-baseline": "@deptrac --formatter=baseline",
+        "composer-update": "[ -d vendor ] || composer update",
+        "yarn-install": "[ -d node_modules ] || yarn install",
+        "markdownlint": [
+            "@yarn-install",
+            "yarn markdownlint"
+        ],
+        "fix-markdownlint": [
+            "@yarn-install",
+            "yarn markdownlint --fix"
+        ],
+        "test": [
+            "@composer-update",
+            "EXIT=0; FAILED=''; { composer check-cs; } || { EXIT=1; FAILED=\"$FAILED check-cs\"; }; { composer phpstan; } || { EXIT=1; FAILED=\"$FAILED phpstan\"; }; { composer deptrac; } || { EXIT=1; FAILED=\"$FAILED deptrac\"; }; { composer check-rector; } || { EXIT=1; FAILED=\"$FAILED check-rector\"; }; { composer markdownlint; } || { EXIT=1; FAILED=\"$FAILED markdownlint\"; }; { composer check-yaml; } || { EXIT=1;  FAILED=\"$FAILED check-yaml\"; }; if [ 1 -eq $EXIT ]; then echo \"Failed:$FAILED\"; fi; exit $EXIT;"
+        ],
+        "fix": [
+            "@composer-update",
+            "@composer fix-rector",
+            "@composer fix-cs",
+            "@composer fix-markdownlint"
+        ],
+        "baseline": [
+            "@composer-update",
+            "@composer phpstan-update-baseline",
+            "@composer deptrac-update-baseline",
+            "@composer yaml-update-baseline"
+        ]
     },
     "scripts-descriptions": {
         "fix-cs": "Automatically fixes code style in all files",
@@ -133,7 +161,16 @@
         "fix-rector": "Automatically applies Rector refactoring to code samples and syncs back to Markdown",
         "check-rector": "Check for code refactoring opportunities",
         "check-yaml": "Run PHPUnit tests (YAML validation)",
-        "yaml-update-baseline": "Regenerate tests/yaml-validation-baseline.yaml from current failures"
+        "yaml-update-baseline": "Regenerate tests/yaml-validation-baseline.yaml from current failures",
+        "phpstan-update-baseline": "Regenerate PHPStan baseline from current failures",
+        "deptrac-update-baseline": "Regenerate Deptrac baseline from current failures",
+        "composer-update": "Install composer dependencies if not already installed",
+        "yarn-install": "Install yarn dependencies if not already installed",
+        "markdownlint": "Run Markdownlint on all documentation files",
+        "fix-markdownlint": "Automatically fixes Markdownlint issues in all documentation files",
+        "test": "Run all checks (CS-Fixer, PHPStan, Deptrac, Rector, Markdownlint, YAML checks), continuing past failures and reporting failure overall if any check failed",
+        "fix": "Run all automatic fixes (Rector, CS-Fixer, Markdownlint)",
+        "baseline": "Regenerate all baselines (PHPStan, Deptrac, YAML) from current failures"
     },
     "config": {
         "allow-plugins": false

docs/templating/twig_function_reference/recommendations_twig_functions.md

@@ -108,26 +108,30 @@ To resolve `websiteId` on the project level, implement the interface as follows:
 
 ``` php
 namespace App\Tracking;
-use Ibexa\Contracts\Core\SiteAccess\ConfigResolverInterface;
-use Ibexa\Contracts\Core\Repository\PermissionResolver;
+
 use Ibexa\Contracts\ConnectorRaptor\Tracking\ContextProvider\WebsiteIdContextProviderInterface;
+use Ibexa\Contracts\Core\Repository\PermissionResolver;
+use Ibexa\Contracts\Core\SiteAccess\ConfigResolverInterface;
+
 final readonly class MyCrmWebsiteUserIdProvider implements WebsiteIdContextProviderInterface
 {
     public function __construct(
-        private ConfigResolverInterface $configResolver, 
+        private ConfigResolverInterface $configResolver,
         private PermissionResolver $permissionResolver,
-    )
-    {
+    ) {
     }
+
     public function getWebsiteId(): ?string
     {
         $currentUserId = $this->permissionResolver->getCurrentUserReference()->getUserId();
         // Don't resolve for anynomous user
         if ($this->isAnonymousUser($currentUserId)) {
             return null;
         }
+
         return $this->getWebsiteUserIdForCurrentUser($currentUserId);
     }
+
     /**
      * @phpstan-return non-empty-string
      */
@@ -136,6 +140,7 @@ final readonly class MyCrmWebsiteUserIdProvider implements WebsiteIdContextProvi
         // Implement custom logic resolving user identifier from the CRM
         return 'custom-identifier-for-the-user-retrieved-from-the-CRM';
     }
+
     private function isAnonymousUser(int $userId): bool
     {
         return (int) $this->configResolver->getParameter('anonymous_user_id') === $userId;