Allow only one of included_domains or excluded_domains

Author: maelanleborgne

src/Translator/doc/index.rst

@@ -74,8 +74,8 @@ Don't worry about your final bundle size, only the translations you use will be
 Configuring the dumped translations
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-By default, all your translations will be dumped as JavaScript. You can restrict the dumped translations by including or
-excluding translation domains in your ``config/packages/ux_translator.yaml`` file:
+By default, all your translations will be dumped as JavaScript. You can restrict the dumped translations by either
+including or excluding translation domains in your ``config/packages/ux_translator.yaml`` file:
 
 .. code-block:: yaml
 

src/Translator/src/DependencyInjection/Configuration.php

@@ -29,14 +29,20 @@ public function getConfigTreeBuilder(): TreeBuilder
             ->children()
                 ->scalarNode('dump_directory')->defaultValue('%kernel.project_dir%/var/translations')->end()
                 ->arrayNode('excluded_domains')
+                    ->info('List of domains to exclude from the generated translations')
                     ->scalarPrototype()->end()
                     ->defaultValue([])
                 ->end()
                 ->arrayNode('included_domains')
+                    ->info('List of domains to include in the generated translations')
                     ->scalarPrototype()->end()
                     ->defaultValue([])
                 ->end()
             ->end()
+            ->validate()
+                ->ifTrue(fn ($v) => $v['excluded_domains'] && $v['included_domains'])
+                ->thenInvalid('You cannot set both "excluded_domains" and "included_domains" at the same time.')
+            ->end()
         ;
 
         return $treeBuilder;

src/Translator/src/TranslationsDumper.php

@@ -88,15 +88,21 @@ public function dump(MessageCatalogueInterface ...$catalogues): void
     }
 
     /**
-    * @param list<string> $domains
-    */
+     * @param list<string> $domains
+     */
     public function setExcludedDomains(array $domains): void
     {
+        if ($this->includedDomains && $domains) {
+            throw new \LogicException('You cannot set both "excluded_domains" and "included_domains" at the same time.');
+        }
         $this->excludedDomains = $domains;
     }
 
     public function setIncludedDomains(array $domains): void
     {
+        if ($this->excludedDomains && $domains) {
+            throw new \LogicException('You cannot set both "excluded_domains" and "included_domains" at the same time.');
+        }
         $this->includedDomains = $domains;
     }
 

src/Translator/tests/TranslationsDumperTest.php

@@ -112,7 +112,7 @@ public function testDumpWithExcludedDomains(): void
         $this->assertStringNotContainsString('foobar', file_get_contents(self::$translationsDumpDir.'/index.js'));
     }
 
-    public function testDumpSpecificDomains(): void
+    public function testDumpIncludedDomains(): void
     {
         $this->translationsDumper->setIncludedDomains(['messages']);
         $this->translationsDumper->dump(...$this->getMessageCatalogues());
@@ -121,16 +121,20 @@ public function testDumpSpecificDomains(): void
         $this->assertStringNotContainsString('foobar', file_get_contents(self::$translationsDumpDir.'/index.js'));
     }
 
-    public function testDumpWithSpecificAndExcludedDomains(): void
+    public function testSetBothIncludedAndExcludedDomains(): void
     {
+        $this->expectException(\LogicException::class);
+        $this->expectExceptionMessage('You cannot set both "excluded_domains" and "included_domains" at the same time.');
         $this->translationsDumper->setIncludedDomains(['foobar']);
         $this->translationsDumper->setExcludedDomains(['foobar']);
-        $this->translationsDumper->dump(...$this->getMessageCatalogues());
+    }
 
-        $this->assertFileExists(self::$translationsDumpDir.'/index.js');
-        $fileContent = file_get_contents(self::$translationsDumpDir.'/index.js');
-        $this->assertStringNotContainsString('foobar', $fileContent);
-        $this->assertStringNotContainsString('messages', $fileContent);
+    public function testSetBothExcludedAndIncludedDomains(): void
+    {
+        $this->expectException(\LogicException::class);
+        $this->expectExceptionMessage('You cannot set both "excluded_domains" and "included_domains" at the same time.');
+        $this->translationsDumper->setExcludedDomains(['foobar']);
+        $this->translationsDumper->setIncludedDomains(['foobar']);
     }
 
     /**