Allow to define an empty prefix for translation:update command #20044

javiereguiluz · 2016-09-24T10:45:07Z

Context

When using the translation:update command to generate a translation file, the translated strings are just the original strings with the __ prefix (e.g. original Contact us, "translation": __Contact us). This value can be changed with the --prefix option.

Problem

When generating the translation file for the original language, I want to use an empty prefix. It seems impossible to do that because of the way Symfony Console options work:

$ ./bin/console translation:update en --dump-messages
# translation prefix = '__';

$ ./bin/console translation:update en --dump-messages --prefix=""
# translation prefix = '__';   <-- ERROR: I expected here an empty prefix

$ ./bin/console translation:update en --dump-messages --prefix=" "
# translation prefix = ' ';

$ ./bin/console translation:update en --dump-messages --prefix="aaa"
# translation prefix = 'aaa';

I think in the past we had some issues reported for the way console options work, but I can't find the issues. Considering that setting an option with an empty value is the same as not setting that option looks confusing and it could even be considered a bug.

The text was updated successfully, but these errors were encountered:

linaori · 2016-09-24T13:45:34Z

@javiereguiluz are you referring to this one? #19946, it's merged already 👍

javiereguiluz · 2016-09-24T13:54:08Z

@iltar thanks for the heads up. I totally missed the fix made by the great @chalasr !

Closing it as fixed then.

lordjancso · 2016-10-07T12:57:21Z

@javiereguiluz I think it's still not working with empty string. Did you test it?

chalasr · 2016-10-07T19:15:45Z

@lordjancso Empty values for command options should be correctly handled since releases v2.7.19, v2.8.12 and v3.1.5 (they should be resolved as null). Could you elaborate?

lordjancso · 2016-10-07T19:36:11Z

@chalasr I'm using 3.1.5 and its still not working. When I execute translation:update with --prefix="" its still not an empty string, because it passes NULL instead of empty string. And as far as I know, NULL is not an empty string.

chalasr · 2016-10-07T19:44:26Z

@lordjancso Yeah, this is the expected behavior (see https://github.com/symfony/symfony/blob/master/src/Symfony/Component/Console/Input/ArgvInput.php#L224-L227). The issue is about that the option was not considered to be set at all, throwing an exception if the option requires a value. Now it converts any empty value into null (as it was expected to do before the fix).

If you think it should not be converted (that I can perfectly understand), please open an issue/PR for proposing to change this.

Please note that $argv does not return empty strings, just no value:

// argv.php
<?php
var_dump($argv);

$ php argv.php --prefix=""
# array(2) {
#   [0]=>
#   string(18) "argv.php"
#   [1]=>
#   string(6) "--prefix="
# }

lordjancso · 2016-10-08T07:11:12Z

@chalasr I see your point but this issue is about allowing to define empty string prefix for translation:update command and since it's still not working, I suggest to re-open it.

chalasr · 2016-10-08T10:15:41Z

@javiereguiluz @lordjancso See #20184

chalasr · 2016-10-08T10:29:13Z

@javiereguiluz The following example:

$ ./bin/console translation:update en --dump-messages --prefix=""
# $prefix = '__';   <-- ERROR: I expected here an empty prefix

Should be:

$ ./bin/console translation:update en --dump-messages --prefix=""
# $prefix = null;   <-- ERROR: I expected here an empty string

Could you please update the description?

javiereguiluz · 2016-10-08T10:40:11Z

@chalasr I was referring to the effective prefix used for translations instead of the value of the $prefix variable. But you are right and I've just updated the description to avoid confusion. Thanks!

chalasr · 2016-10-08T10:44:01Z

@javiereguiluz Yeah, sorry I forgot to precise it needs to be updated since #19946 only

…n translation:update (chalasr) This PR was merged into the 2.7 branch. Discussion ---------- [FrameworkBundle] Convert null prefix to an empty string in translation:update | Q | A | ------------- | --- | Branch? | 2.7 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #20044 | License | MIT | Doc PR | n/a This command needs the ability to use an empty string as prefix, which is not possible using `bin/console translation:update --prefix=""` because `$argv` doesn't parse empty strings thus the value is converted to `null` by `ArgvInput` (only since #19946, before the option was not considered to be set, giving the default `'__'` thus this should be fine from a BC pov). Here I propose to explicitly convert the `prefix` value to an empty string if set to `null`, as it is a very specific need and we can't guess that from `ArgvInput`. An other way to fix it could be to add a `--no-prefix` option to the command but I don't think it is worth it, and it couldn't be treated as a bug fix thus not fixed before `3.2`. Commits ------- f02b687 [FrameworkBundle] Convert null prefix to an empty string in translation:update command

…date (chalasr) This PR was merged into the 3.2-dev branch. Discussion ---------- [FrameworkBundle] Add --no-prefix option to translation:update | Q | A | ------------- | --- | Branch? | master | Bug fix? | yes | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #20044 | License | MIT | Doc PR | n/a This adds an option `--no-prefix` to the `translation:update` command, allowing to use an empty string as prefix. I guess it should be treated as a feature as it adds a new option to the command, but it indeed fixes the bug reported in #20044 (yeah, really this time). Commits ------- b5a1584 [FrameworkBundle] Add --no-prefix option to translation:update

…date (chalasr) This PR was merged into the 3.2-dev branch. Discussion ---------- [FrameworkBundle] Add --no-prefix option to translation:update | Q | A | ------------- | --- | Branch? | master | Bug fix? | yes | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | symfony/symfony#20044 | License | MIT | Doc PR | n/a This adds an option `--no-prefix` to the `translation:update` command, allowing to use an empty string as prefix. I guess it should be treated as a feature as it adds a new option to the command, but it indeed fixes the bug reported in #20044 (yeah, really this time). Commits ------- b5a1584 [FrameworkBundle] Add --no-prefix option to translation:update

javiereguiluz added Feature Translation labels Sep 24, 2016

javiereguiluz changed the title ~~Allow to define an empty prefix for translation:update command~~ Allow to define an empty prefix for translation:update command Sep 24, 2016

javiereguiluz closed this as completed Sep 24, 2016

javiereguiluz reopened this Oct 8, 2016

chalasr mentioned this issue Oct 8, 2016

[FrameworkBundle] Convert null prefix to an empty string in translation:update #20184

Merged

fabpot closed this as completed Oct 9, 2016

chalasr mentioned this issue Nov 7, 2016

[FrameworkBundle] Add --no-prefix option to translation:update #20432

Merged

xabbuh reopened this Nov 7, 2016

fabpot closed this as completed Nov 11, 2016

This was referenced Jan 9, 2017

[Console] Add a way to check if an argument/option was provided #21210

Closed

[Console] Support empty values for options #21215

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Allow to define an empty prefix for translation:update command #20044

Allow to define an empty prefix for translation:update command #20044

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Allow to define an empty prefix for translation:update command #20044

Allow to define an empty prefix for translation:update command #20044

Comments

Uh oh!

Context

Problem

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!