[FEATURE] Make allowed file extensions configurable for all file processors (#343)

Author: chrissonntag

README.md

@@ -168,6 +168,42 @@ Possible values for `TypoScriptProcessorOption::CONDITION_TERMINATION`:
 - `PrettyPrinterConditionTermination::EnforceGlobal` will always end with `[global]`
 - `PrettyPrinterConditionTermination::EnforceEnd` will always end with `[end]`
 
+### Configure the allowed file extensions
+
+By default, Fractor processes files based on their extensions. You can customize which file extensions each processor should handle by configuring the `ALLOWED_FILE_EXTENSIONS` option.
+
+The following are the default extensions processed for each file type:
+
+- **Fluid**: `html`, `xml`, `txt`
+- **TypoScript**: `typoscript`, `tsconfig`, `ts`
+- **XML**: `xml`
+- **YAML**: `yaml`, `yml`
+
+To override these defaults, use the configuration that looks similiar to the following:
+
+```php
+<?php
+
+use a9f\Fractor\Configuration\FractorConfiguration;
+use a9f\FractorFluid\Configuration\FluidProcessorOption;
+use a9f\FractorTypoScript\Configuration\TypoScriptProcessorOption;
+use a9f\FractorXml\Configuration\XmlProcessorOption;
+use a9f\FractorYaml\Configuration\YamlProcessorOption;
+
+return FractorConfiguration::configure()
+    ->withOptions([
+        // Only process html files
+        FluidProcessorOption::ALLOWED_FILE_EXTENSIONS => ['html'],
+        // Remove ts files and only process typoscript and tsconfig
+        TypoScriptProcessorOption::ALLOWED_FILE_EXTENSIONS => ['typoscript', 'tsconfig'],
+        // Also process xlf files
+        XmlProcessorOption::ALLOWED_FILE_EXTENSIONS => ['xml', 'xlf'],
+        // Keep defaults - can be omitted in that case
+        YamlProcessorOption::ALLOWED_FILE_EXTENSIONS => ['yaml', 'yml'],
+    ]);
+
+```
+
 ## Processing
 
 Before executing the code migrations, run the following command to see a preview of what Fractor will do:

packages/fractor-fluid/config/application.php

@@ -4,8 +4,10 @@
 
 use a9f\FractorFluid\Contract\FluidFractorRule;
 use a9f\FractorFluid\FluidFileProcessor;
+use a9f\FractorFluid\ValueObject\FluidFormatConfiguration;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+use function Symfony\Component\DependencyInjection\Loader\Configurator\service;
 use function Symfony\Component\DependencyInjection\Loader\Configurator\tagged_iterator;
 
 return static function (ContainerConfigurator $containerConfigurator, ContainerBuilder $containerBuilder): void {
@@ -16,8 +18,12 @@
 
     $services->load('a9f\\FractorFluid\\', __DIR__ . '/../src/');
 
+    $services->set('fractor.fluid_processor.format_configuration', FluidFormatConfiguration::class)
+        ->factory([null, 'createFromParameterBag']);
+
     $services->set(FluidFileProcessor::class)
-        ->arg('$rules', tagged_iterator('fractor.fluid_rule'));
+        ->arg('$rules', tagged_iterator('fractor.fluid_rule'))
+        ->arg('$fluidFormatConfiguration', service('fractor.fluid_processor.format_configuration'));
 
     $containerBuilder->registerForAutoconfiguration(FluidFractorRule::class)->addTag('fractor.fluid_rule');
 };

packages/fractor-fluid/src/Configuration/FluidProcessorOption.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace a9f\FractorFluid\Configuration;
+
+final class FluidProcessorOption
+{
+    public const ALLOWED_FILE_EXTENSIONS = 'fluid-processor-allowed-file-extensions';
+}

packages/fractor-fluid/src/FluidFileProcessor.php

@@ -9,6 +9,7 @@
 use a9f\Fractor\Application\ValueObject\File;
 use a9f\Fractor\Caching\Detector\ChangedFilesDetector;
 use a9f\FractorFluid\Contract\FluidFractorRule;
+use a9f\FractorFluid\ValueObject\FluidFormatConfiguration;
 
 /**
  * @implements FileProcessor<FluidFractorRule>
@@ -20,7 +21,8 @@
      */
     public function __construct(
         private iterable $rules,
-        private ChangedFilesDetector $changedFilesDetector
+        private ChangedFilesDetector $changedFilesDetector,
+        private FluidFormatConfiguration $fluidFormatConfiguration
     ) {
     }
 
@@ -43,9 +45,12 @@ public function handle(File $file, iterable $appliedRules): void
         }
     }
 
+    /**
+     * @return list<non-empty-string>
+     */
     public function allowedFileExtensions(): array
     {
-        return ['html', 'xml', 'txt'];
+        return $this->fluidFormatConfiguration->allowedFileExtensions;
     }
 
     public function getAllRules(): iterable

packages/fractor-fluid/src/ValueObject/FluidFormatConfiguration.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace a9f\FractorFluid\ValueObject;
+
+use a9f\FractorFluid\Configuration\FluidProcessorOption;
+use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface;
+
+final readonly class FluidFormatConfiguration
+{
+    /**
+     * @param list<non-empty-string> $allowedFileExtensions
+     */
+    public function __construct(
+        public array $allowedFileExtensions
+    ) {
+    }
+
+    public static function createFromParameterBag(ParameterBagInterface $parameterBag): self
+    {
+        /** @var list<non-empty-string> $allowedFileExtensions */
+        $allowedFileExtensions = $parameterBag->has(FluidProcessorOption::ALLOWED_FILE_EXTENSIONS)
+            ? $parameterBag->get(FluidProcessorOption::ALLOWED_FILE_EXTENSIONS)
+            : ['html', 'xml', 'txt'];
+
+        return new self($allowedFileExtensions);
+    }
+}

packages/fractor-fluid/tests/FluidFileProcessor/FluidFileProcessorConfigurationTest.php

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace a9f\FractorFluid\Tests\FluidFileProcessor;
+
+use a9f\FractorFluid\Configuration\FluidProcessorOption;
+use a9f\FractorFluid\ValueObject\FluidFormatConfiguration;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
+
+final class FluidFileProcessorConfigurationTest extends TestCase
+{
+    #[Test]
+    public function defaultFileExtensions(): void
+    {
+        $parameterBag = new ParameterBag([]);
+        $configuration = FluidFormatConfiguration::createFromParameterBag($parameterBag);
+
+        self::assertSame(['html', 'xml', 'txt'], $configuration->allowedFileExtensions);
+    }
+
+    #[Test]
+    public function customFileExtensions(): void
+    {
+        $parameterBag = new ParameterBag([
+            FluidProcessorOption::ALLOWED_FILE_EXTENSIONS => ['html'],
+        ]);
+        $configuration = FluidFormatConfiguration::createFromParameterBag($parameterBag);
+
+        self::assertSame(['html'], $configuration->allowedFileExtensions);
+    }
+
+    #[Test]
+    public function multipleCustomFileExtensions(): void
+    {
+        $parameterBag = new ParameterBag([
+            FluidProcessorOption::ALLOWED_FILE_EXTENSIONS => ['html', 'xml'],
+        ]);
+        $configuration = FluidFormatConfiguration::createFromParameterBag($parameterBag);
+
+        self::assertSame(['html', 'xml'], $configuration->allowedFileExtensions);
+    }
+}

packages/fractor-typoscript/src/Configuration/TypoScriptProcessorOption.php

@@ -17,4 +17,6 @@ final class TypoScriptProcessorOption
     public const INDENT_CONDITIONS = 'typoscript-processor-indent-conditions';
 
     public const CONDITION_TERMINATION = 'typoscript-processor-condition-termination';
+
+    public const ALLOWED_FILE_EXTENSIONS = 'typoscript-processor-allowed-file-extensions';
 }

packages/fractor-typoscript/src/TypoScriptFileProcessor.php

@@ -39,7 +39,7 @@ public function __construct(
 
     public function canHandle(File $file): bool
     {
-        return in_array($file->getFileExtension(), $this->allowedFileExtensions());
+        return in_array($file->getFileExtension(), $this->allowedFileExtensions(), true);
     }
 
     public function handle(File $file, iterable $appliedRules): void
@@ -75,10 +75,12 @@ public function handle(File $file, iterable $appliedRules): void
         }
     }
 
+    /**
+     * @return list<non-empty-string>
+     */
     public function allowedFileExtensions(): array
     {
-        // TODO this should be configurable
-        return ['typoscript', 'tsconfig', 'ts'];
+        return $this->typoScriptPrettyPrinterFormatConfiguration->allowedFileExtensions;
     }
 
     public function getAllRules(): iterable

packages/fractor-typoscript/src/ValueObject/TypoScriptPrettyPrinterFormatConfiguration.php

@@ -10,13 +10,17 @@
 
 final readonly class TypoScriptPrettyPrinterFormatConfiguration
 {
+    /**
+     * @param list<non-empty-string> $allowedFileExtensions
+     */
     public function __construct(
         public int $size,
         public string $style,
         public bool $addClosingGlobal,
         public bool $includeEmptyLineBreaks,
         public bool $indentConditions,
-        public PrettyPrinterConditionTermination $conditionTermination
+        public PrettyPrinterConditionTermination $conditionTermination,
+        public array $allowedFileExtensions
     ) {
     }
 
@@ -48,13 +52,19 @@ public static function createFromParameterBag(ParameterBagInterface $parameterBa
             ? $parameterBag->get(TypoScriptProcessorOption::CONDITION_TERMINATION)
             : PrettyPrinterConditionTermination::Keep;
 
+        /** @var list<non-empty-string> $allowedFileExtensions */
+        $allowedFileExtensions = $parameterBag->has(TypoScriptProcessorOption::ALLOWED_FILE_EXTENSIONS)
+            ? $parameterBag->get(TypoScriptProcessorOption::ALLOWED_FILE_EXTENSIONS)
+            : ['typoscript', 'tsconfig', 'ts'];
+
         return new self(
             $size,
             $style,
             $addClosingGlobal,
             $includeEmptyLineBreaks,
             $indentConditions,
-            $conditionTermination
+            $conditionTermination,
+            $allowedFileExtensions
         );
     }
 }

packages/fractor-typoscript/tests/TypoScriptFileProcessor/TypoScriptFileProcessorConfigurationTest.php

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace a9f\FractorTypoScript\Tests\TypoScriptFileProcessor;
+
+use a9f\FractorTypoScript\Configuration\TypoScriptProcessorOption;
+use a9f\FractorTypoScript\ValueObject\TypoScriptPrettyPrinterFormatConfiguration;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
+
+final class TypoScriptFileProcessorConfigurationTest extends TestCase
+{
+    #[Test]
+    public function defaultFileExtensions(): void
+    {
+        $parameterBag = new ParameterBag([]);
+        $configuration = TypoScriptPrettyPrinterFormatConfiguration::createFromParameterBag($parameterBag);
+
+        self::assertSame(['typoscript', 'tsconfig', 'ts'], $configuration->allowedFileExtensions);
+    }
+
+    #[Test]
+    public function customFileExtensions(): void
+    {
+        $parameterBag = new ParameterBag([
+            TypoScriptProcessorOption::ALLOWED_FILE_EXTENSIONS => ['typoscript', 'tss'],
+        ]);
+        $configuration = TypoScriptPrettyPrinterFormatConfiguration::createFromParameterBag($parameterBag);
+
+        self::assertSame(['typoscript', 'tss'], $configuration->allowedFileExtensions);
+    }
+
+    #[Test]
+    public function multipleCustomFileExtensions(): void
+    {
+        $parameterBag = new ParameterBag([
+            TypoScriptProcessorOption::ALLOWED_FILE_EXTENSIONS => ['typoscript', 'tsconfig', 'tss', 'tsc'],
+        ]);
+        $configuration = TypoScriptPrettyPrinterFormatConfiguration::createFromParameterBag($parameterBag);
+
+        self::assertSame(['typoscript', 'tsconfig', 'tss', 'tsc'], $configuration->allowedFileExtensions);
+    }
+}