[BUGFIX] Ignore localization folders

resolves #348

Author: linawolf

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

@@ -3,6 +3,7 @@
 declare(strict_types=1);
 
 use Brotkrueml\TwigCodeHighlight\Extension as CodeHighlight;
+use phpDocumentor\Guides\Event\PostCollectFilesForParsingEvent;
 use phpDocumentor\Guides\Event\PostProjectNodeCreated;
 use phpDocumentor\Guides\Event\PostRenderProcess;
 use phpDocumentor\Guides\Event\PreParseProcess;
@@ -20,6 +21,7 @@
 
 use T3Docs\Typo3DocsTheme\Directives\T3FieldListTableDirective;
 use T3Docs\Typo3DocsTheme\Directives\YoutubeDirective;
+use T3Docs\Typo3DocsTheme\EventListeners\IgnoreLocalizationsFolders;
 use T3Docs\Typo3DocsTheme\EventListeners\TestingModeActivator;
 use T3Docs\Typo3DocsTheme\Inventory\Typo3InventoryRepository;
 use T3Docs\Typo3DocsTheme\Parser\ExtendedInterlinkParser;
@@ -72,12 +74,16 @@
         ->tag('twig.extension')
         ->autowire()
 
+        // Register Event Listeners
         ->set(AddThemeSettingsToProjectNode::class)
         ->tag('event_listener', ['event' => PostProjectNodeCreated::class])
 
         ->set(CopyResources::class)
         ->tag('event_listener', ['event' => PostRenderProcess::class])
 
+        ->set(IgnoreLocalizationsFolders::class)
+        ->tag('event_listener', ['event' => PostCollectFilesForParsingEvent::class])
+
         ->set(TestingModeActivator::class)
         ->tag('event_listener', ['event' => PreParseProcess::class]);
 };

packages/typo3-docs-theme/src/EventListeners/IgnoreLocalizationsFolder.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace T3Docs\Typo3DocsTheme\EventListeners;
+
+use phpDocumentor\Guides\Event\PostCollectFilesForParsingEvent;
+use phpDocumentor\Guides\Files;
+
+final class IgnoreLocalizationsFolder
+{
+    /**
+     * @see https://regex101.com/r/zUNAFQ/1
+     */
+    private const LOCALIZATION_FOLDER_REGEX = '/^Localization\\.[a-z]+_[A-Z]+/s';
+    public function __invoke(PostCollectFilesForParsingEvent $event): void
+    {
+        $files = $event->getFiles();
+        $newFiles = new Files();
+        foreach ($files as $filePath) {
+            if (!preg_match(self::LOCALIZATION_FOLDER_REGEX, $filePath)) {
+                $newFiles->add($filePath);
+            }
+        }
+        $event->setFiles($newFiles);
+    }
+}

packages/typo3-docs-theme/src/EventListeners/IgnoreLocalizationsFolders.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace T3Docs\Typo3DocsTheme\EventListeners;
+
+use phpDocumentor\Guides\Event\PostCollectFilesForParsingEvent;
+use phpDocumentor\Guides\Files;
+
+final class IgnoreLocalizationsFolders
+{
+    /**
+     * Format as described here: https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/HowToAddTranslation/Index.html
+     * Currently only simplified tags of form xx_YY are supported.
+     * todo: change this to BCP 47 in the future? deployment actions and language/version switch have to be changed accordingly
+     * @see https://regex101.com/r/zUNAFQ/1
+     */
+    private const LOCALIZATION_FOLDER_REGEX = '/^Localization\\.[a-z]{2}_[A-Z]{2}/s';
+    public function __invoke(PostCollectFilesForParsingEvent $event): void
+    {
+        $files = $event->getFiles();
+        $newFiles = new Files();
+        foreach ($files as $filePath) {
+            if (!preg_match(self::LOCALIZATION_FOLDER_REGEX, $filePath)) {
+                $newFiles->add($filePath);
+            }
+        }
+        $event->setFiles($newFiles);
+    }
+}