Support shim install; improve workflow (#9)

* Support shim install

* Improve workflow

* Fix workflow

* Fix workflow harder :)

* Upgrade gh actions

Author: uuf6429

.github/workflows/ci.yml

@@ -9,6 +9,8 @@ on:
     release:
         types:
             - created
+    schedule:
+        -   cron: '0 0 * * *'
 
 jobs:
     check_actions:
@@ -33,7 +35,7 @@ jobs:
             -   run: composer validate --strict --no-check-lock
 
     check_code:
-        name: Analyse code
+        name: Check code
         runs-on: ubuntu-latest
         steps:
             -   uses: actions/checkout@v6
@@ -57,15 +59,15 @@ jobs:
             -   run: diff -u README.md .generated-readme.md
 
     tests:
-        name: Build & Test (${{ matrix.osName }}, PHP ${{ matrix.php }})
+        name: Build & Test (PHP ${{ matrix.php }} ${{ matrix.desc }})
         runs-on: ${{ matrix.os }}
         strategy:
             fail-fast: false
             matrix:
+                desc:
+                    - 'on Ubuntu'
                 os:
                     - 'ubuntu-latest'
-                osName:
-                    - 'Ubuntu'
                 php:
                     - '7.4'
                     - '8.0'
@@ -75,28 +77,50 @@ jobs:
                     - '8.4'
                     - '8.5'
                 include:
-                    -   os: 'macos-15-intel'
-                        osName: 'macOS'
+                    -   desc: 'on macOS'
+                        os: 'macos-15-intel'
                         php: '8.4'
-                    -   os: 'windows-latest'
-                        osName: 'Windows'
+                    -   desc: 'on Windows'
+                        os: 'windows-latest'
                         php: '8.4'
+                    -   desc: '+ bootstrap, on Ubuntu'
+                        os: 'ubuntu-latest'
+                        php: '8.4'
+                        bootstrap: true
         steps:
             -   uses: actions/checkout@v6
             -   uses: shivammathur/setup-php@v2
                 with:
                     php-version: "${{ matrix.php }}"
                     ini-file: "development"
                     coverage: "xdebug"
+            -   id: composer-cache
+                shell: bash
+                run: echo "dir=$(composer config cache-dir)" >> "$GITHUB_OUTPUT"
+            -   uses: actions/cache@v4
+                with:
+                    path: ${{ steps.composer-cache.outputs.dir }}
+                    key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
             -   if: matrix.os == 'macos-15-intel'
                 uses: douglascamata/setup-docker-macos-action@v1.1.0
+            -   if: ${{ matrix.bootstrap }}
+                # language=bash
+                run: |
+                    jq -r --indent 4 'del(.autoload."psr-4")' composer.json > composer.tmp
+                    jq -r --indent 4 '.autoload += {"files": ["bootstrap.php"]}' composer.tmp > composer.json
             -   run: composer update --ansi --no-progress
             -   run: composer test -- --coverage-clover=coverage.xml --log-junit junit.xml --testdox
-            -   uses: codecov/codecov-action@v6
+            -   if: ${{ !cancelled() }}
+                uses: codecov/codecov-action@v6
                 with:
                     token: ${{ secrets.CODECOV_TOKEN }}
-                    files: coverage.xml
-                    flags: php${{ matrix.php }}
-            -   uses: codecov/test-results-action@v1
+                    report_type: coverage
+                    name: "Coverage: PHP ${{ matrix.php }} ${{ matrix.desc }}"
+                    flags: ${{ runner.os }}-php-${{ matrix.php }}
+            -   if: ${{ !cancelled() }}
+                uses: codecov/codecov-action@v6
                 with:
                     token: ${{ secrets.CODECOV_TOKEN }}
+                    report_type: test_results
+                    name: "Tests: PHP ${{ matrix.php }} ${{ matrix.desc }}"
+                    flags: ${{ runner.os }}-php-${{ matrix.php }}

README.md

@@ -42,6 +42,13 @@ return (new PhpCsFixer\Config())
     ->setFinder(...);
 ```
 
+> [!WARNING]
+> If PHP CS Fixer is installed via [`php-cs-fixer/shim`](https://github.com/PHP-CS-Fixer/shim) package, you may have to
+> require the bootstrap file:
+> ```php
+> require __DIR__ . '/vendor/uuf6429/php-cs-fixer-blockstring/bootstrap.php';
+> ```
+
 ## 💡 Before You Start
 
 <details>

bootstrap.php

@@ -0,0 +1,9 @@
+<?php declare(strict_types=1);
+
+spl_autoload_register(static function (string $class): void {
+	if (strncmp($class, 'uuf6429\\PhpCsFixerBlockstring\\', 30) !== 0) {
+		return;
+	}
+
+	require __DIR__ . '/src/' . str_replace('\\', '/', substr($class, 30)) . '.php';
+});

phpstan.dist.neon

@@ -7,6 +7,7 @@ parameters:
 	paths:
 		- ./src
 		- ./tests
+		- ./bootstrap.php
 	excludePaths:
 		- ./tests/fixtures/*
 	ignoreErrors:

tools/readmerator/README.tpl.md

@@ -42,6 +42,13 @@ return (new PhpCsFixer\Config())
     ->setFinder(...);
 ```
 
+> [!WARNING]
+> If PHP CS Fixer is installed via [`php-cs-fixer/shim`](https://github.com/PHP-CS-Fixer/shim) package, you may have to
+> require the bootstrap file:
+> ```php
+> require __DIR__ . '/vendor/uuf6429/php-cs-fixer-blockstring/bootstrap.php';
+> ```
+
 ## 💡 Before You Start
 
 <details>