Skip to content

#18012: added i18n wrapper to be used in underscore templates for translation #26435

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Feb 7, 2020
Merged

#18012: added i18n wrapper to be used in underscore templates for translation #26435

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
819c3f2
#18012: added i18n wrapper to be used in underscore templates for tra…
Jan 17, 2020
064ee0e
Merge branch '2.4-develop' into 18012-add-translation-to-underscore
Jan 20, 2020
3a19f17
#18012: updated JS config 'i18n_translation' pattern in order to add …
Jan 20, 2020
c32b643
#18012: added description for _.i18n
Jan 20, 2020
e26bbc1
Merge branch '2.4-develop' into 18012-add-translation-to-underscore
Jan 22, 2020
69d07c1
#18012: improved cases for DataProviderTest
Jan 23, 2020
58adcc5
#18012: updated description for DataProviderTest
Jan 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions app/code/Magento/Translation/Test/Unit/Model/Js/DataProviderTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
use Magento\Framework\Phrase\Renderer\Translate;

/**
* Class DataProviderTest
* Verify data provider translation
*
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
*/
Expand Down Expand Up @@ -105,24 +105,31 @@ public function testGetData()
'hello1' => 'hello1translated',
'hello2' => 'hello2translated',
'hello3' => 'hello3translated',
'hello4' => 'hello4translated'
'hello4' => 'hello4translated',
'ko i18' => 'ko i18 translated',
'underscore i18' => 'underscore i18 translated',
];

$contentsMap = [
'content1$.mage.__("hello1")content1',
'content2$.mage.__("hello2")content2',
'content2$.mage.__("hello4")content4', // this value should be last after running data provider
'content2$.mage.__("hello3")content3',
'content2$.mage.__("hello4")content4 <!-- ko i18n: "ko i18" --><!-- /ko -->',
'content2$.mage.__("hello3")content3 <% _.i18n("underscore i18") %>',
];

$translateMap = [
[['hello1'], [], 'hello1translated'],
[['hello2'], [], 'hello2translated'],
[['hello3'], [], 'hello3translated'],
[['hello4'], [], 'hello4translated']
[['hello4'], [], 'hello4translated'],
[['ko i18'], [], 'ko i18 translated'],
[['underscore i18'], [], 'underscore i18 translated'],
];

$patterns = ['~\$\.mage\.__\(([\'"])(.+?)\1\)~'];
$patterns = [
'~\$\.mage\.__\(([\'"])(.+?)\1\)~',
'~(?:i18n\:|_\.i18n\()\s*(["\'])(.*?)(?<!\\\\)\1~',
];

$this->appStateMock->expects($this->once())
->method('getAreaCode')
Expand Down
2 changes: 1 addition & 1 deletion app/code/Magento/Translation/etc/di.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
<type name="Magento\Translation\Model\Js\Config">
<arguments>
<argument name="patterns" xsi:type="array">
<item name="i18n_translation" xsi:type="string"><![CDATA[~i18n\:\s*(["'])(.*?)(?<!\\)\1~]]></item>
<item name="i18n_translation" xsi:type="string"><![CDATA[~(?:i18n\:|_\.i18n\()\s*(["'])(.*?)(?<!\\)\1~]]></item>
<item name="translate_wrapping" xsi:type="string"><![CDATA[~translate\=("')([^\'].*?)\'\"~]]></item>
<item name="mage_translation_widget" xsi:type="string"><![CDATA[~(?s)(?:\$|jQuery)\.mage\.__\(\s*(['"])(?<translate>.+?)(?<!\\)\1\s*(*SKIP)\)\s*(?s)~]]></item>
<item name="mage_translation_static" xsi:type="string"><![CDATA[~(?s)\$t\(\s*(['"])(?<translate>.+?)(?<!\\)\1\s*(*SKIP)\)(?s)~]]></item>
Expand Down
18 changes: 16 additions & 2 deletions lib/web/mage/translate.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@
define([
'jquery',
'mage/mage',
'mageTranslationDictionary'
], function ($, mage, dictionary) {
'mageTranslationDictionary',
'underscore'
], function ($, mage, dictionary, _) {
'use strict';

$.extend(true, $, {
Expand Down Expand Up @@ -46,5 +47,18 @@ define([
});
$.mage.__ = $.proxy($.mage.translate.translate, $.mage.translate);

// Provide i18n wrapper to be used in underscore templates for translation
_.extend(_, {
/**
* Make a translation using $.mage.__
*
* @param {String} text
* @return {String}
*/
i18n: function (text) {
return $.mage.__(text);
}
});

return $.mage.__;
});