Merge pull request #12 from jolicode/maintenance

Maintenance commit

Author: xavierlacot

.castor/qa.php

@@ -12,10 +12,11 @@
 namespace qa;
 
 use Castor\Attribute\AsOption;
+use Castor\Attribute\AsRawTokens;
 use Castor\Attribute\AsTask;
 use Symfony\Component\Console\Input\InputOption;
 
-use function Castor\context;
+use function Castor\exit_code;
 use function Castor\run;
 
 #[AsTask(description: 'Runs all QA tasks')]
@@ -47,6 +48,25 @@ function install(?string $only = null): void
     }
 }
 
+#[AsTask(description: 'Update tooling')]
+function update(?string $only = null): void
+{
+    $map = [
+        'php-cs-fixer' => fn () => run('composer update --working-dir tools/php-cs-fixer'),
+        'phpstan' => fn () => run('composer update --working-dir tools/phpstan'),
+        'phpunit' => fn () => run('composer update --working-dir tools/phpunit'),
+        'rector' => fn () => run('composer update --working-dir tools/rector'),
+    ];
+
+    if ($only) {
+        $map = array_filter($map, fn ($key) => $key === $only, \ARRAY_FILTER_USE_KEY);
+    }
+
+    foreach ($map as $task) {
+        $task();
+    }
+}
+
 #[AsTask(description: 'Fix coding standards', aliases: ['cs'])]
 function cs(
     #[AsOption(name: 'dry-run', description: 'Do not make changes and outputs diff', mode: InputOption::VALUE_NONE)]
@@ -58,31 +78,23 @@ function cs(
         $command .= ' --dry-run --diff';
     }
 
-    $c = context()
-        ->withAllowFailure(true)
-    ;
-
-    return run($command, context: $c)->getExitCode();
+    return exit_code($command);
 }
 
 #[AsTask(description: 'Run the phpstan analysis', aliases: ['phpstan'])]
 function phpstan(): int
 {
-    return run('tools/phpstan/vendor/bin/phpstan analyse')->getExitCode();
+    return exit_code('tools/phpstan/vendor/bin/phpstan analyse -v');
 }
 
-#[AsTask(description: 'Run the phpunit tests', aliases: ['phpunit'])]
-function phpunit(): int
+#[AsTask(description: 'Run the phpunit tests', ignoreValidationErrors: true, aliases: ['phpunit'])]
+function phpunit(#[AsRawTokens] array $rawTokens): int
 {
-    $c = context()
-        ->withAllowFailure(true)
-    ;
-
-    return run('tools/phpunit/vendor/bin/simple-phpunit', context: $c)->getExitCode();
+    return exit_code(['tools/phpunit/vendor/bin/phpunit', ...$rawTokens]);
 }
 
 #[AsTask(description: 'Run the rector upgrade', aliases: ['rector'])]
 function rector(): int
 {
-    return run('tools/rector/vendor/bin/rector process')->getExitCode();
+    return exit_code('tools/rector/vendor/bin/rector process');
 }

.github/workflows/ci.yml

@@ -15,18 +15,18 @@ jobs:
         strategy:
             matrix:
                 php-versions:
-                    - "8.1"
-                    - "8.2"
                     - "8.3"
+                    - "8.4"
+                    - "8.5"
         steps:
             - name: Checkout
-              uses: actions/checkout@v4
+              uses: actions/checkout@v5
 
             - name: Setup PHP
               uses: shivammathur/setup-php@v2
               with:
                   php-version: "${{ matrix.php-versions }}"
-                  tools: jolicode/castor
+                  tools: castor
 
             - name: Validate composer.json and composer.lock
               run: composer validate --strict
@@ -49,13 +49,13 @@ jobs:
 
         steps:
             - name: Checkout
-              uses: actions/checkout@v4
+              uses: actions/checkout@v5
 
             - name: Setup PHP
               uses: shivammathur/setup-php@v2
               with:
                   php-version: 8.3
-                  tools: jolicode/castor
+                  tools: castor
 
             - name: Install dependencies
               run: castor install

.php-cs-fixer.dist.php

@@ -30,7 +30,7 @@
 return (new PhpCsFixer\Config())
     ->setRiskyAllowed(true)
     ->setRules([
-        '@PHP81Migration' => true,
+        '@PHP83Migration' => true,
         '@Symfony' => true,
         '@Symfony:risky' => true,
         'concat_space' => ['spacing' => 'one'],

composer.json

@@ -16,7 +16,7 @@
         }
     },
     "require": {
-        "php": ">=8.1",
+        "php": ">=8.3",
         "ext-mbstring": "*",
         "lib-libxml": "*",
         "league/commonmark": "^2.4",

phpunit.xml.dist

@@ -1,22 +1,20 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd" backupGlobals="false"
-    colors="true" bootstrap="vendor/autoload.php">
-    <php>
-        <ini name="error_reporting" value="-1" />
-        <env name="SYMFONY_DEPRECATIONS_HELPER" value="max[direct]=0" />
-    </php>
-    <testsuites>
-        <testsuite name="JoliMarkdown Test Suite">
-            <directory>./tests/</directory>
-        </testsuite>
-    </testsuites>
-    <coverage>
-        <include>
-            <directory>./</directory>
-        </include>
-        <exclude>
-            <directory>./vendor</directory>
-        </exclude>
-    </coverage>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/12.4/phpunit.xsd" backupGlobals="false" colors="true" bootstrap="vendor/autoload.php">
+  <php>
+    <ini name="error_reporting" value="-1"/>
+    <env name="SYMFONY_DEPRECATIONS_HELPER" value="max[direct]=0"/>
+  </php>
+  <testsuites>
+    <testsuite name="JoliMarkdown Test Suite">
+      <directory>./tests/</directory>
+    </testsuite>
+  </testsuites>
+  <source>
+    <include>
+      <directory>./</directory>
+    </include>
+    <exclude>
+      <directory>./vendor</directory>
+    </exclude>
+  </source>
 </phpunit>

src/Bridge/Symfony/DependencyInjection/Configuration.php

@@ -16,10 +16,14 @@
 
 class Configuration implements ConfigurationInterface
 {
+    /**
+     * @return TreeBuilder<'array'>
+     */
     public function getConfigTreeBuilder(): TreeBuilder
     {
         $treeBuilder = new TreeBuilder('joli_markdown');
 
+        /* @phpstan-ignore class.notFound */
         $treeBuilder->getRootNode()
             ->children()
                 ->booleanNode('prefer_asterisk_over_underscore')

src/Fixer/HtmlBlockFixer.php

@@ -207,7 +207,7 @@ protected function buildNodeFromDomElement(\DOMNode $element, bool $allowLtrim =
 
                 if (\count($attributes) > 0) {
                     // the span has attributes, so enclose its childNodes in CommonmarkContainers
-                    $openingNode = new InlineCommonmarkContainer(sprintf(
+                    $openingNode = new InlineCommonmarkContainer(\sprintf(
                         '<span%s>',
                         $this->outputAttributes($attributes),
                     ));
@@ -292,15 +292,15 @@ protected function buildNodeFromDomElement(\DOMNode $element, bool $allowLtrim =
                     // try to let self-closed html tags as-is
                     preg_match('/^<\s*([a-z0-9-]+)(\s[^>]*)?\/>$/', $elementXml, $matches);
 
-                    if (isset($matches[1]) && preg_match(sprintf('/^<%s(\s[^>]*)?\>.*<\/%s>$/', $matches[1], $matches[1]), $converted, $subMatches)) {
+                    if (isset($matches[1]) && preg_match(\sprintf('/^<%s(\s[^>]*)?\>.*<\/%s>$/', $matches[1], $matches[1]), $converted, $subMatches)) {
                         if (\in_array($matches[1], ['br', 'hr', 'source'])) {
                             $converted = $elementXml;
                         } else {
                             $converted = $elementHtml;
                         }
                     }
 
-                    if (isset($tagNameMatches[1]) || isset($matches[1]) && preg_match(sprintf('/^<%s(\s.*)?>$/', $matches[1]), $converted, $subMatches)) {
+                    if (isset($tagNameMatches[1]) || isset($matches[1]) && preg_match(\sprintf('/^<%s(\s.*)?>$/', $matches[1]), $converted, $subMatches)) {
                         $attributes = [];
                     }
                 } else {
@@ -445,10 +445,10 @@ protected function fixAndReplace(string|array $literal, Node|array $nodes, strin
             $attributes = '';
 
             foreach ($nodes[0]->data->get('attributes') as $key => $value) {
-                $attributes .= sprintf(' %s="%s"', $key, Xml::escape($value));
+                $attributes .= \sprintf(' %s="%s"', $key, Xml::escape($value));
             }
 
-            $literal = sprintf('<div%s>%s</div>', $attributes, $literal);
+            $literal = \sprintf('<div%s>%s</div>', $attributes, $literal);
         }
 
         $dom = new \DOMDocument();
@@ -498,6 +498,7 @@ protected function removeNode(Node $node): void
 
         foreach ($newChildren as $key => $child) {
             if ($child === $node) {
+                // @phpstan-ignore offsetAccess.nonOffsetAccessible
                 unset($newChildren[$key]);
             }
         }
@@ -602,7 +603,7 @@ private function fixHtmlBlock(HtmlBlock $node): ?iterable
         }
 
         if (!$isClosed) {
-            $this->logger->info(sprintf('<%s> tag is NOT closed', $matches[1]));
+            $this->logger->info(\sprintf('<%s> tag is NOT closed', $matches[1]));
         }
 
         $fixedNodes = $this->fixAndReplace($literal, $closingNodes);

src/Fixer/HtmlInlineFixer.php

@@ -103,7 +103,7 @@ private function fixHtmlInline(HtmlInline $node): ?iterable
         }
 
         if (!$isClosed) {
-            $this->logger->info(sprintf('<%s> tag is NOT closed', $matches[1]));
+            $this->logger->info(\sprintf('<%s> tag is NOT closed', $matches[1]));
         }
 
         $fixedNodes = $this->fixAndReplace(

src/Fixer/ImageFixer.php

@@ -47,7 +47,7 @@ public function fix(Node $node): ?iterable
 
             if (str_starts_with($node->getUrl(), 'http')) {
                 $this->logger->notice(
-                    sprintf(
+                    \sprintf(
                         'Image with absolute path found: %s',
                         $node->getUrl(),
                     )

src/MarkdownFixer.php

@@ -46,7 +46,7 @@ public function __construct(
         $internalDomains = $environment->getConfiguration()->get('joli_markdown/internal_domains');
 
         if (\is_array($internalDomains) && 0 !== \count($internalDomains)) {
-            $internalDomainsPattern = sprintf(
+            $internalDomainsPattern = \sprintf(
                 '#^(https?)?://(%s)/?#',
                 implode('|', $internalDomains),
             );