This PR introduces non-zero exit codes upon failure for thedebug:translations command. The addition can be useful for projects which wish to determine results easily in CI.

The exit code returned can be interpreted as a bit array and to determine what failed, one could Bitwise AND the returned exit code to determine what failed.

Exit Codes:

Failure Reason	bit array	integer
General Failure (i.e no translations at all)	`1000000`	64
Missing Translations	`1000001`	65
Unused Translations	`1000010`	66
Fallback Translations	`1000100`	68

Example: Given there are missing and unused translations, the expected status code would beTranslationDebugCommand::EXIT_CODE_MISSING | TranslationDebugCommand::EXIT_CODE_UNUSED, which would be evaluated to67.

carsonbot added Status: Needs Review FrameworkBundle Feature labels

Nov 8, 2018

DAcodedBEAT force-pushed thedebug_translation_add_strict_option branch from7965ed3 to0e4e925Compare

November 8, 2018 13:42

nicolas-grekas added this to thenext milestone

Nov 8, 2018

Copy link

ContributorAuthor

DAcodedBEAT commentedNov 13, 2018•
edited
Loading

Hi everyone! First time symfony contributor here. It’d be super swell to get this merged in. What do I need to do to get some code review for this?

Conan-Kudo approved these changes

Nov 14, 2018

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels

Nov 14, 2018

Copy link

ContributorAuthor

DAcodedBEAT commentedNov 20, 2018•
edited
Loading

@nicolas-grekas @fabpot what should I do to expedite the process of merging this in?

Copy link

Member

nicolas-grekas commentedNov 20, 2018

We're in feature freeze finalizing version 4.2. we'll start merging new features again in two to three weeks (after/during SymfonyCon Lisbon I'd say.)
Thanks for your patience.

nicolas-grekas reviewed

Dec 13, 2018

View reviewed changes

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

		@@ -81,6 +84,7 @@ protected function configure()
		new InputOption('only-missing', null, InputOption::VALUE_NONE, 'Displays only missing messages'),
		new InputOption('only-unused', null, InputOption::VALUE_NONE, 'Displays only unused messages'),
		new InputOption('all', null, InputOption::VALUE_NONE, 'Load messages from all registered bundles'),
		new InputOption('strict', null, InputOption::VALUE_OPTIONAL, 'Returns a non-zero exit code upon failure', false),

Copy link

Member

nicolas-grekasDec 13, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

at first, the description made me think this was a boolean option.
what about--fail-on-missing etc (would be more flexible also)?

Copy link

Member

fabpot commentedMar 4, 2019

Not a big fan of adding a new flag for that. I think not returning a non-zero exit code was a mistake and should be done without a flag.

DAcodedBEAT force-pushed thedebug_translation_add_strict_option branch from0e4e925 toed56b0dCompare

March 6, 2019 13:18

Copy link

ContributorAuthor

DAcodedBEAT commentedMar 6, 2019

Hello@fabpot and@nicolas-grekas! Apologies for the delay. Originally I thought it was silly to not return a non-zero exit code by default as well, but then I realized that this command could be used for fallback messages. Because of this, knowing when to return a non-zero status code could be difficult (e.g. should the command return a non-zero exit code due to missing a localized translation or should it return a successful zero exit code because a fallback could be used instead).

When initially writing the this PR, I pulled inspiration from composer's outdated command and the ability to increase verbosity levels in numerous commands (-v vs-vvv), but I could definitely be convinced to pivot to an alternative. 🙂

DAcodedBEAT force-pushed thedebug_translation_add_strict_option branch 2 times, most recently frome1b45e9 to990dbc0Compare

May 28, 2019 16:55

Copy link

Member

fabpot commentedJul 8, 2019

I still think that this should not be configurable via an option. The return code could be different based on the kind of errors though.

DAcodedBEAT force-pushed thedebug_translation_add_strict_option branch from990dbc0 to3a9f7c3Compare

July 11, 2019 11:18

DAcodedBEAT changed the title~~[FrameworkBundle][TranslationDebug] add strict option~~[FrameworkBundle][TranslationDebug] Return non-zero exit code on failure

Jul 11, 2019

Copy link

ContributorAuthor

DAcodedBEAT commentedJul 11, 2019

@fabpot I have changed this PR to return a non-zero exit code on failure. Can you please re-review this?
@nicolas-grekas Given these turn of events, would you still want these--fail-on-* options added to this PR?

Thank you both for your feedback 🙂

fabpot requested changes

Jul 12, 2019

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/Command/TranslationDebugCommand.php OutdatedShow resolvedHide resolved

carsonbot added Status: Needs Work and removed Status: Reviewed labels

Jul 12, 2019

Copy link

Member

fabpot commentedJan 10, 2020

@DAcodedBEAT Still interested in finishing this PR?

DAcodedBEAT force-pushed thedebug_translation_add_strict_option branch from3a9f7c3 to3dfcc8eCompare

January 30, 2020 04:45

Copy link

ContributorAuthor

DAcodedBEAT commentedJan 30, 2020

Hello@fabpot! Sorry for the delay. Yes, I am still interested in finishing this Pull Request! I have pushed up the changes requested. Thank you for the reminder! 🙂