phpDocumentor Guides integration

.github/workflows/ci.yaml

@@ -20,7 +20,7 @@ jobs:
               uses: shivammathur/setup-php@v2
               with:
                   coverage: none
-                  php-version: 8.3
+                  php-version: 8.4
                   tools: composer:v2
                   ini-values: date.timezone=UTC
 
@@ -37,7 +37,7 @@ jobs:
                 # add here only the PHP versions and OS used in GitHub CI (for tests)
                 # and on the symfony.com server (where the Symfony Docs are built)
                 operating-system: ['ubuntu-latest']
-                php-version: ['8.3', '8.4']
+                php-version: ['8.4', '8.5']
 
         steps:
             - name: 'Checkout code'
@@ -51,8 +51,8 @@ jobs:
                   tools: composer:v2
                   ini-values: date.timezone=UTC
 
-            -   name: Install Composer Dependencies
-                run: composer install --no-progress
+            - name: Install Composer Dependencies
+              run: composer install --no-progress
 
-            -   name: PHPUnit
-                run: vendor/bin/simple-phpunit
+            - name: PHPUnit
+              run: composer test

.gitignore

@@ -1,8 +1,11 @@
+!tools/*/composer.lock
 /vendor/
 /tests/_output
 /tests/_cache
 /var/
 /docs.phar
 /.env
+/.php-cs-fixer.cache
 /.phpunit.result.cache
+/.phpunit.cache
 /composer.lock

.php-cs-fixer.dist.php

@@ -0,0 +1,34 @@
+<?php
+
+$fileHeaderComment = <<<EOT
+This file is part of the Guides SymfonyExtension package.
+
+(c) Wouter de Jong
+
+For the full copyright and license information, please view the LICENSE
+file that was distributed with this source code.
+EOT;
+
+return (new PhpCsFixer\Config())
+    ->setRules([
+        '@PHP71Migration' => true,
+        '@PHPUnit75Migration:risky' => true,
+        '@Symfony' => true,
+        '@Symfony:risky' => true,
+        'protected_to_private' => false,
+        'native_constant_invocation' => ['strict' => false],
+        'no_superfluous_phpdoc_tags' => [
+            'remove_inheritdoc' => true,
+            'allow_unused_params' => true, // for future-ready params, to be replaced with https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/issues/7377
+        ],
+        'header_comment' => ['header' => $fileHeaderComment],
+        'modernize_strpos' => true,
+        'get_class_to_class_keyword' => true,
+        'nullable_type_declaration' => true,
+    ])
+    ->setRiskyAllowed(true)
+    ->setFinder(
+        (new PhpCsFixer\Finder())
+            ->in(__DIR__.'/src')
+    )
+;

LICENSE

@@ -1,6 +1,7 @@
 The MIT license
 
 Copyright (c) 2018-present Ryan Weaver
+Copyright (c) 2023-present Wouter de Jong
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

composer.json

@@ -5,33 +5,53 @@
     "license": "MIT",
     "autoload": {
         "psr-4": {
+            "SymfonyTools\\DocsBuilder\\GuidesExtension\\": "src/GuidesExtension/src",
             "SymfonyDocsBuilder\\": "src"
         }
     },
     "autoload-dev": {
         "psr-4": {
+            "SymfonyTools\\DocsBuilder\\Tests\\": "tests",
             "SymfonyDocsBuilder\\Tests\\": "tests"
         }
     },
     "require": {
-        "php": ">=8.3",
+        "php": ">=8.4",
         "ext-json": "*",
         "ext-curl": "*",
-        "doctrine/rst-parser": "^0.5",
-        "scrivo/highlight.php": "^9.18.1",
-        "symfony/filesystem": "^5.2 || ^6.0 || ^7.0 || ^8.0",
-        "symfony/finder": "^5.2 || ^6.0 || ^7.0 || ^8.0",
-        "symfony/dom-crawler": "^5.2 || ^6.0 || ^7.0 || ^8.0",
-        "symfony/css-selector": "^5.2 || ^6.0 || ^7.0 || ^8.0",
-        "symfony/console": "^5.2 || ^6.0 || ^7.0 || ^8.0",
-        "symfony/http-client": "^5.2 || ^6.0 || ^7.0 || ^8.0",
-        "twig/twig": "^2.14 || ^3.3"
+        "phpdocumentor/guides": "^1.10@dev",
+        "phpdocumentor/guides-cli": "^1.9",
+        "phpdocumentor/guides-code": "^1.7",
+        "phpdocumentor/guides-restructured-text": "^1.10@dev",
+        "scrivo/highlight.php": "^9.12.0",
+        "symfony/config": "^8.0",
+        "symfony/filesystem": "^8.0",
+        "symfony/finder": "^8.0",
+        "symfony/event-dispatcher": "^8.0",
+        "symfony/dependency-injection": "^8.0",
+        "symfony/dom-crawler": "^8.0",
+        "symfony/css-selector": "^8.0",
+        "symfony/console": "^8.0",
+        "symfony/http-client": "^8.0",
+        "symfony/string": "^8.0",
+        "twig/twig": "^3.3",
+        "twig/string-extra": "^3.6"
     },
     "require-dev": {
-        "gajus/dindent": "^2.0",
-        "symfony/phpunit-bridge": "^5.2 || ^6.0 || ^7.0 || ^8.0",
-        "symfony/process": "^5.2 || ^6.0 || ^7.0 || ^8.0",
-        "masterminds/html5": "^2.7"
+        "league/flysystem-memory": "^3.0",
+        "symfony/process": "^8.0",
+        "symfony/var-dumper": "^8.0",
+        "phpunit/phpunit": "^12"
     },
-    "bin": ["bin/docs-builder"]
+    "scripts": {
+        "test": "phpunit",
+        "psalm": [
+            "composer update --no-scripts --working-dir=tools/psalm",
+            "./tools/psalm/vendor/bin/psalm"
+        ],
+        "cs": [
+            "composer update --no-scripts --working-dir=tools/php-cs-fixer",
+            "./tools/php-cs-fixer/vendor/bin/php-cs-fixer fix"
+        ]
+    }
 }

phpunit.xml

@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/12.4/phpunit.xsd"
+    bootstrap="vendor/autoload.php"
+    beStrictAboutOutputDuringTests="true"
+    failOnDeprecation="true"
+    failOnRisky="true"
+    failOnWarning="true"
+    cacheDirectory=".phpunit.cache"
+    beStrictAboutCoverageMetadata="true">
+    <testsuites>
+        <testsuite name="default">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+
+    <source ignoreSuppressionOfDeprecations="true"
+        ignoreIndirectDeprecations="true"
+        restrictNotices="true"
+        restrictWarnings="true">
+        <include>
+            <directory>src</directory>
+        </include>
+
+        <deprecationTrigger>
+            <function>trigger_deprecation</function>
+            <method>Doctrine\Deprecations\Deprecation::trigger</method>
+            <method>Doctrine\Deprecations\Deprecation::delegateTriggerToBackend</method>
+        </deprecationTrigger>
+    </source>
+</phpunit>

psalm.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0"?>
+<psalm
+    errorLevel="2"
+    resolveFromConfigFile="true"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns="https://getpsalm.org/schema/config"
+    xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+    findUnusedCode="false"
+    findUnusedBaselineEntry="true"
+>
+    <projectFiles>
+        <directory name="src" />
+        <directory name="config" />
+        <ignoreFiles>
+            <directory name="vendor" />
+        </ignoreFiles>
+    </projectFiles>
+
+    <issueHandlers>
+        <ImplicitToStringCast errorLevel="suppress" />
+    </issueHandlers>
+</psalm>