[FEAT] use current filename to get the original file name (#788)

This will make markdown rendering work with less errors.

Author: jaapio

composer.json

@@ -7,9 +7,11 @@
         "ext-dom": "*",
         "ext-libxml": "*",
         "brotkrueml/twig-codehighlight": "^0.1.1",
-        "phpdocumentor/guides-cli": "^1.0",
+        "phpdocumentor/guides": "^1.6",
+        "phpdocumentor/guides-cli": "^1.5",
         "phpdocumentor/guides-graphs": "^1.0",
-        "phpdocumentor/guides-markdown": "^1.0",
+        "phpdocumentor/guides-markdown": "^1.5",
+        "phpdocumentor/guides-restructured-text": "^1.5",
         "phpdocumentor/guides-theme-bootstrap": "^1.0",
         "symfony/clock": "^6.4",
         "symfony/finder": "^6.4",
@@ -54,6 +56,7 @@
     "config": {
         "allow-plugins": {
             "ergebnis/composer-normalize": true,
+            "phpdocumentor/shim": true,
             "phpstan/extension-installer": true
         },
         "platform": {

composer.lock

@@ -4,6 +4,7 @@
 
 use Brotkrueml\TwigCodeHighlight\Extension as CodeHighlight;
 use phpDocumentor\Guides\Event\PostCollectFilesForParsingEvent;
+use phpDocumentor\Guides\Event\PostParseDocument;
 use phpDocumentor\Guides\Event\PostProjectNodeCreated;
 use phpDocumentor\Guides\Event\PostRenderProcess;
 use phpDocumentor\Guides\Event\PreParseProcess;
@@ -33,6 +34,7 @@
 use T3Docs\Typo3DocsTheme\EventListeners\AddThemeSettingsToProjectNode;
 use T3Docs\Typo3DocsTheme\EventListeners\CopyResources;
 use T3Docs\Typo3DocsTheme\EventListeners\IgnoreLocalizationsFolders;
+use T3Docs\Typo3DocsTheme\EventListeners\OriginalFileNameSetter;
 use T3Docs\Typo3DocsTheme\EventListeners\TestingModeActivator;
 use T3Docs\Typo3DocsTheme\Inventory\Typo3InventoryRepository;
 use T3Docs\Typo3DocsTheme\Packagist\PackagistService;
@@ -197,5 +199,8 @@
         ->tag('event_listener', ['event' => PostCollectFilesForParsingEvent::class])
 
         ->set(TestingModeActivator::class)
-        ->tag('event_listener', ['event' => PreParseProcess::class]);
+        ->tag('event_listener', ['event' => PreParseProcess::class])
+
+        ->set(OriginalFileNameSetter::class)
+        ->tag('event_listener', ['event' => PostParseDocument::class]);
 };

packages/typo3-docs-theme/resources/config/typo3-docs-theme.php

@@ -8,7 +8,7 @@
     {% endif -%}
     {%- set copySources = getSettings('copy_sources') -%}
     {%- if (copySources)  %}
-    <a class="btn btn-sm btn-light" href="{{ copyDownload(env.currentFileName ~ '.rst', '_sources/' ~ env.currentFileName ~ '.rst.txt') }}" rel="nofollow noopener" target="_blank">
+    <a class="btn btn-sm btn-light" href="{{ copyDownload(sourceFilename(), '_sources/' ~ sourceFilename() ~ '.txt') }}" rel="nofollow noopener" target="_blank">
         <span class="btn-icon"><span class="fas fa-code"></span></span>
         <span class="btn-text">View source</span>
     </a>

packages/typo3-docs-theme/resources/template/structure/layoutParts/editOnGithubButtons.html.twig

@@ -9,7 +9,7 @@
     <p class="caption">Contributors Corner</p>
     <ul class="menu-level-1">
         {%- if (copySources)  %}
-            <li><a href="{{ copyDownload(env.currentFileName ~ '.rst', '_sources/' ~ env.currentFileName ~ '.rst.txt') }}" rel="nofollow noopener" target="_blank">
+            <li><a href="{{ copyDownload(sourceFilename(), '_sources/' ~ sourceFilename() ~ '.txt') }}" rel="nofollow noopener" target="_blank">
                     View source of current document
             </a></li>
         {% endif -%}

packages/typo3-docs-theme/resources/template/structure/navigation/meta-menu.html.twig

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace T3Docs\Typo3DocsTheme\EventListeners;
+
+use phpDocumentor\Guides\Event\PostParseDocument;
+
+final class OriginalFileNameSetter
+{
+    public function __invoke(PostParseDocument $event): void
+    {
+        $event->setDocumentNode(
+            $event->getDocumentNode()?->withKeepExistingOptions(['originalFileName' => $event->getOriginalFileName()])
+        );
+    }
+}