[FrameworkBundle] Add completion to debug:translation command #43644

alexandre-daubois · 2021-10-22T06:44:04Z

Q	A
Branch?	5.4
Bug fix?	no
New feature?	yes
Deprecations?	no
Tickets	Part of #43594
License	MIT
Doc PR	NA

GromNaN · 2021-10-22T07:18:12Z

Completion don't have to be exhaustive. Bundle names can be completed getting the name of each bundle provided by $kernel->getBundles(). That would be useful.

GromNaN · 2021-10-22T07:26:54Z

src/Symfony/Bundle/FrameworkBundle/Command/TranslationDebugCommand.php

+    public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void
+    {
+        if ($input->mustSuggestArgumentValuesFor('locale')) {
+            $suggestions->suggestValues(Locales::getLocales());


This is a very long list. Since this command describes the state of the application, I think it would be more useful if only the used locales were listed.

No problem, taking a look at it!

I'm working on another translation related command that require to autocomplete for locale too.
I'm thinking if we're going to have only used locales, maybe we will need to add getUsedLocals() into ExtractorInterface and TranslationReaderInterface

So far I only know the we need to do as below if we're adding into the interface.
TranslationReader need to put the logic for getting the Locales
ChainExtractor and PhpExtractor also need to add the logic to get used Locales.

Quick global search within the repo also gave me one more class that needs update:
Symfony\Bridge\Twig\Translation\TwigExtractor

But not quite sure if it will affect other third party package.

https://github.com/symfony/symfony/blob/4.4/src/Symfony/Component/Translation/Loader/LoaderInterface.php

Also might need to consider third party translation loader included as the autocomplete suggestions.

FrameworkBundle has a concept of enabled locales. I suggest using those for the completion.

Does this really make sense to limit locales completion to the "enabled" ones in the project, aside that it seems tricky to get these enabled locales? Symfony already bundles a lot of messages in dozens of locales. Restricting completion could kind of prevent displaying messages defined by Symfony in domains like the validators one.

Here, it's only about completion, I'm fine with auto-completing only the enabled locales. If you want another one, just type it explicitly.

Alright, I'm on it!

@stephenkhoo to access the enabled locales, use DI, i.e. inject them in the command constructor.

Got it, thanks

alexandre-daubois · 2021-10-22T07:29:08Z

Completion don't have to be exhaustive. Bundle names can be completed getting the name of each bundle provided by $kernel->getBundles(). That would be useful.

Suits me fine. Added!

src/Symfony/Bundle/FrameworkBundle/Command/TranslationDebugCommand.php

…n:update command (stephenkhoo) This PR was squashed before being merged into the 5.4 branch. Discussion ---------- [FrameworkBundle] Add completion feature on translation:update command | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | Part of #43594 | License | MIT | Doc PR | - Adding completion for translation:update. - [x] locale - [X] bundle - [X] --format - [X] --domain - [X] --sort Test for - [x] locale - [x] bundle - [X] --format - [X] --domain - [X] --sort Locale completion still under discussion in #43644 (review) Locale and bundle test still not complete Commits ------- 2f301ae [FrameworkBundle] Add completion feature on translation:update command

…n:update command (stephenkhoo) This PR was squashed before being merged into the 5.4 branch. Discussion ---------- [FrameworkBundle] Add completion feature on translation:update command | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | Part of #43594 | License | MIT | Doc PR | - Adding completion for translation:update. - [x] locale - [X] bundle - [X] --format - [X] --domain - [X] --sort Test for - [x] locale - [x] bundle - [X] --format - [X] --domain - [X] --sort Locale completion still under discussion in symfony/symfony#43644 (review) Locale and bundle test still not complete Commits ------- 2f301ae9e1 [FrameworkBundle] Add completion feature on translation:update command

fabpot · 2021-10-29T15:03:50Z

Thank you @alexandre-daubois.

GromNaN · 2021-11-02T21:24:50Z

src/Symfony/Bundle/FrameworkBundle/Tests/Command/TranslationDebugCommandTest.php

+
+        yield 'bundle' => [
+            ['fr', '--domain', 'messages', ''],
+            ['ExtensionWithoutConfigTestBundle', 'extension_without_config_test'],


I get an exception when I use the bundle_name in snake case. Does it work for you? (It's ok with BundleName)

$ bin/console debug:translation en framework "framework/translations" is neither an enabled bundle nor a directory.

Taking a look ASAP 👍

carsonbot added Status: Needs Review Console Feature labels Oct 22, 2021

carsonbot added this to the 5.4 milestone Oct 22, 2021

alexandre-daubois force-pushed the feat/debug-translation-autocomplete branch 3 times, most recently from 2d1f985 to b0a55a4 Compare October 22, 2021 07:01

GromNaN reviewed Oct 22, 2021

View reviewed changes

alexandre-daubois force-pushed the feat/debug-translation-autocomplete branch from b0a55a4 to a1c32b4 Compare October 22, 2021 07:28

alexandre-daubois force-pushed the feat/debug-translation-autocomplete branch from a1c32b4 to 1388391 Compare October 22, 2021 07:29

wouterj mentioned this pull request Oct 22, 2021

[DX] Add completion to Symfony commands #43594

Closed

54 tasks

stephenkhoo reviewed Oct 23, 2021

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/Command/TranslationDebugCommand.php Show resolved Hide resolved

stephenkhoo mentioned this pull request Oct 23, 2021

[FrameworkBundle] Add completion feature on translation:update command #43676

Merged

10 tasks

derrabus added FrameworkBundle and removed Console labels Oct 24, 2021

carsonbot changed the title ~~[Console] Add completion to debug:translation command~~ [FrameworkBundle] Add completion to debug:translation command Oct 24, 2021

alexandre-daubois force-pushed the feat/debug-translation-autocomplete branch 3 times, most recently from 1529f97 to 454d1b5 Compare October 25, 2021 16:32

fabpot requested changes Oct 26, 2021

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/Command/TranslationDebugCommand.php Show resolved Hide resolved

carsonbot added Status: Needs Work and removed Status: Needs Review labels Oct 26, 2021

alexandre-daubois force-pushed the feat/debug-translation-autocomplete branch from 454d1b5 to 621d83c Compare October 26, 2021 14:19

[Console] Add completion to debug:translation command

086a8b4

alexandre-daubois force-pushed the feat/debug-translation-autocomplete branch from 621d83c to 086a8b4 Compare October 26, 2021 14:21

fabpot approved these changes Oct 29, 2021

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Work labels Oct 29, 2021

fabpot mentioned this pull request Oct 29, 2021

[FrameworkBundle] Add completion to debug:translation command symfony/symfony-docs#16037

Closed

fabpot merged commit 12f8fae into symfony:5.4 Oct 29, 2021

GromNaN reviewed Nov 2, 2021

View reviewed changes

This was referenced Nov 5, 2021

Release v5.4.0-BETA1 #43937

Merged

Release v6.0.0-BETA1 #43939

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FrameworkBundle] Add completion to debug:translation command #43644

[FrameworkBundle] Add completion to debug:translation command #43644

alexandre-daubois commented Oct 22, 2021 •

edited

Loading

GromNaN commented Oct 22, 2021

GromNaN Oct 22, 2021

alexandre-daubois Oct 22, 2021

stephenkhoo Oct 23, 2021 •

edited

Loading

stephenkhoo Oct 23, 2021

stof Oct 23, 2021

alexandre-daubois Oct 24, 2021

fabpot Oct 25, 2021 •

edited

Loading

alexandre-daubois Oct 25, 2021

stof Oct 25, 2021

stephenkhoo Oct 25, 2021

alexandre-daubois commented Oct 22, 2021

fabpot commented Oct 29, 2021

GromNaN Nov 2, 2021

alexandre-daubois Nov 3, 2021

[FrameworkBundle] Add completion to debug:translation command #43644

[FrameworkBundle] Add completion to debug:translation command #43644

Conversation

alexandre-daubois commented Oct 22, 2021 • edited Loading

GromNaN commented Oct 22, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stephenkhoo Oct 23, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fabpot Oct 25, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alexandre-daubois commented Oct 22, 2021

fabpot commented Oct 29, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alexandre-daubois commented Oct 22, 2021 •

edited

Loading

stephenkhoo Oct 23, 2021 •

edited

Loading

fabpot Oct 25, 2021 •

edited

Loading