[FEATURE] Add TranslationFileFractor for Yaml

typo3-fractor/rules/TYPO3v10/Yaml/TranslationFileFractor.php

@@ -0,0 +1,98 @@
+<?php
+
+declare(strict_types=1);
+
+namespace a9f\Typo3Fractor\TYPO3v10\Yaml;
+
+use a9f\FractorYaml\Contract\YamlFractorRule;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+final class TranslationFileFractor implements YamlFractorRule
+{
+    /**
+     * @var string
+     */
+    private const TRANSLATION_FILE_KEY = 'translationFile';
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Use key translationFiles instead of translationFile', [
+            new CodeSample(
+                <<<'CODE_SAMPLE'
+TYPO3:
+  CMS:
+    Form:
+      prototypes:
+        standard:
+          formElementsDefinition:
+            Form:
+              renderingOptions:
+                translation:
+                  translationFile:
+                    10: 'EXT:form/Resources/Private/Language/locallang.xlf'
+                    20: 'EXT:myextension/Resources/Private/Language/locallang.xlf'
+CODE_SAMPLE
+                ,
+                <<<'CODE_SAMPLE'
+TYPO3:
+  CMS:
+    Form:
+      prototypes:
+        standard:
+          formElementsDefinition:
+            Form:
+              renderingOptions:
+                translation:
+                  translationFiles:
+                    20: 'EXT:myextension/Resources/Private/Language/locallang.xlf'
+CODE_SAMPLE
+            ),
+        ]);
+    }
+
+    public function refactor(array $yaml): array
+    {
+        return $this->refactorTranslationFile($yaml);
+    }
+
+    /**
+     * @param mixed[] $yaml
+     * @return mixed[]
+     * @see https://github.com/TYPO3/typo3/blob/10.4/typo3/sysext/form/Classes/Controller/FormEditorController.php#L653-L689
+     */
+    private function refactorTranslationFile(array &$yaml): array
+    {
+        foreach ($yaml as &$section) {
+            if (! is_array($section)) {
+                continue;
+            }
+
+            if (array_key_exists(self::TRANSLATION_FILE_KEY, $section)
+                && is_array($section[self::TRANSLATION_FILE_KEY])
+            ) {
+                $section['translationFiles'] = $this->buildNewTranslations($section[self::TRANSLATION_FILE_KEY]);
+                unset($section[self::TRANSLATION_FILE_KEY]);
+            }
+
+            $this->refactorTranslationFile($section);
+        }
+
+        unset($section);
+
+        return $yaml;
+    }
+
+    /**
+     * @param array<int, string> $oldTranslations
+     *
+     * @return array<int, string>
+     */
+    private function buildNewTranslations(array $oldTranslations): array
+    {
+        return array_filter(
+            $oldTranslations,
+            static fn ($oldTranslationFile): bool => ! \str_starts_with((string) $oldTranslationFile, 'EXT:form')
+        );
+    }
+}

typo3-fractor/tests/Rules/TYPO3v10/Yaml/TranslationFileFractor/Fixtures/form_setup.form.yaml

@@ -0,0 +1,24 @@
+TYPO3:
+  CMS:
+    Form:
+      prototypes:
+        standard:
+          formElementsDefinition:
+            Form:
+              renderingOptions:
+                translation:
+                  translationFile:
+                    10: 'EXT:form/Resources/Private/Language/locallang.xlf'
+                    20: 'EXT:myextension/Resources/Private/Language/locallang.xlf'
+-----
+TYPO3:
+  CMS:
+    Form:
+      prototypes:
+        standard:
+          formElementsDefinition:
+            Form:
+              renderingOptions:
+                translation:
+                  translationFiles:
+                    20: 'EXT:myextension/Resources/Private/Language/locallang.xlf'

typo3-fractor/tests/Rules/TYPO3v10/Yaml/TranslationFileFractor/TranslationFileFractorTest.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rules\TYPO3v10\Yaml\TranslationFileFractor;
+
+use a9f\Fractor\Testing\PHPUnit\AbstractFractorTestCase;
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+
+final class TranslationFileFractorTest extends AbstractFractorTestCase
+{
+    #[DataProvider('provideData')]
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+    }
+
+    public static function provideData(): Iterator
+    {
+        return self::yieldFilesFromDirectory(__DIR__ . '/Fixtures', '*.yaml');
+    }
+
+    public function provideConfigFilePath(): ?string
+    {
+        return __DIR__ . '/config/fractor.php';
+    }
+
+    protected function additionalConfigurationFiles(): array
+    {
+        return [__DIR__ . '/config/config.php'];
+    }
+}

typo3-fractor/tests/Rules/TYPO3v10/Yaml/TranslationFileFractor/config/config.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+
+return static function (ContainerConfigurator $containerConfigurator): void {
+    $containerConfigurator->import(__DIR__ . '/../../../../../../config/application.php');
+};

typo3-fractor/tests/Rules/TYPO3v10/Yaml/TranslationFileFractor/config/fractor.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+use a9f\Fractor\Configuration\FractorConfiguration;
+use a9f\Typo3Fractor\TYPO3v10\Yaml\TranslationFileFractor;
+
+return FractorConfiguration::configure()
+    ->withRules([TranslationFileFractor::class]);