feature #38393 [FrameworkBundle] Add option --as-tree to translation:update command (jschaedl)

fabpot · fabpot · commit 81833b623599 · 2020-10-06T07:39:06.000+02:00
This PR was squashed before being merged into the 5.2-dev branch. Discussion ---------- [FrameworkBundle] Add option --as-tree to translation:update command | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes  | Deprecations? |no  | Tickets | Fix #38344  | License | MIT | Doc PR | tbd.  Before: ``` $ bin/console translation:update --domain messages --output-format=yml --force en # messages.yaml app.backend.title: __app.backend.title app.backend.content: __app.backend.content ``` After: ``` $ bin/console translation:update --domain messages --output-format=yml --force --as-tree=3 en # messages.yaml app: backend: title: __app.backend.title content: __app.backend.content ``` Commits ------- 62cb77a [FrameworkBundle] Add option --as-tree to translation:update command
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -13,6 +13,7 @@ CHANGELOG
  * added `framework.http_client.retry_failing` configuration tree
  * added `assertCheckboxChecked()` and `assertCheckboxNotChecked()` in `WebTestCase`
  * added `assertFormValue()` and `assertNoFormValue()` in `WebTestCase`
+ * Added "--as-tree=3" option to `translation:update` command to dump messages as a tree-like structure. The given value defines the level where to switch to inline YAML
 
 5.1.0
 -----
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/TranslationUpdateCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/TranslationUpdateCommand.php
@@ -84,6 +84,7 @@ protected function configure()
                 new InputOption('domain', null, InputOption::VALUE_OPTIONAL, 'Specify the domain to update'),
                 new InputOption('xliff-version', null, InputOption::VALUE_OPTIONAL, 'Override the default xliff version', '1.2'),
                 new InputOption('sort', null, InputOption::VALUE_OPTIONAL, 'Return list of messages sorted alphabetically', 'asc'),
+                new InputOption('as-tree', null, InputOption::VALUE_OPTIONAL, 'Dump the messages as a tree-like structure: The given value defines the level where to switch to inline YAML'),
             ])
             ->setDescription('Updates the translation file')
             ->setHelp(<<<'EOF'
@@ -108,6 +109,12 @@ protected function configure()
 
     <info>php %command.full_name% --dump-messages --sort=asc en AcmeBundle</info>
     <info>php %command.full_name% --dump-messages --sort=desc fr</info>
+
+You can dump a tree-like structure using the yaml format with <comment>--as-tree</> flag:
+
+    <info>php %command.full_name% --force --output-format=yaml --as-tree=3 en AcmeBundle</info>
+    <info>php %command.full_name% --force --output-format=yaml --sort=asc --as-tree=3 fr</info>
+
 EOF
             )
         ;
@@ -302,7 +309,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 $bundleTransPath = end($transPaths);
             }
 
-            $this->writer->write($operation->getResult(), $input->getOption('output-format'), ['path' => $bundleTransPath, 'default_locale' => $this->defaultLocale, 'xliff_version' => $input->getOption('xliff-version')]);
+            $this->writer->write($operation->getResult(), $input->getOption('output-format'), ['path' => $bundleTransPath, 'default_locale' => $this->defaultLocale, 'xliff_version' => $input->getOption('xliff-version'), 'as_tree' => $input->getOption('as-tree'), 'inline' => $input->getOption('as-tree') ?? 0]);
 
             if (true === $input->getOption('dump-messages')) {
                 $resultMessage .= ' and translation files were updated';
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Command/TranslationUpdateCommandTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Command/TranslationUpdateCommandTest.php
@@ -32,6 +32,14 @@ public function testDumpMessagesAndClean()
         $this->assertMatchesRegularExpression('/1 message was successfully extracted/', $tester->getDisplay());
     }
 
+    public function testDumpMessagesAsTreeAndClean()
+    {
+        $tester = $this->createCommandTester(['messages' => ['foo' => 'foo']]);
+        $tester->execute(['command' => 'translation:update', 'locale' => 'en', 'bundle' => 'foo', '--dump-messages' => true, '--clean' => true, '--as-tree' => 1]);
+        $this->assertMatchesRegularExpression('/foo/', $tester->getDisplay());
+        $this->assertMatchesRegularExpression('/1 message was successfully extracted/', $tester->getDisplay());
+    }
+
     public function testDumpSortedMessagesAndClean()
     {
         $tester = $this->createCommandTester(['messages' => ['foo' => 'foo', 'test' => 'test', 'bar' => 'bar']]);

Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,14 @@ public function testDumpMessagesAndClean()`
`32`	`32`	`$this->assertMatchesRegularExpression('/1 message was successfully extracted/', $tester->getDisplay());`
`33`	`33`	`}`
`34`	`34`
	`35`	`+ public function testDumpMessagesAsTreeAndClean()`
	`36`	`+ {`
	`37`	`+ $tester = $this->createCommandTester(['messages' => ['foo' => 'foo']]);`
	`38`	`+ $tester->execute(['command' => 'translation:update', 'locale' => 'en', 'bundle' => 'foo', '--dump-messages' => true, '--clean' => true, '--as-tree' => 1]);`
	`39`	`+ $this->assertMatchesRegularExpression('/foo/', $tester->getDisplay());`
	`40`	`+ $this->assertMatchesRegularExpression('/1 message was successfully extracted/', $tester->getDisplay());`
	`41`	`+ }`
	`42`	`+`
`35`	`43`	`public function testDumpSortedMessagesAndClean()`
`36`	`44`	`{`
`37`	`45`	`$tester = $this->createCommandTester(['messages' => ['foo' => 'foo', 'test' => 'test', 'bar' => 'bar']]);`