Skip to content
This repository has been archived by the owner on Sep 6, 2021. It is now read-only.

fix Issue #8953- "Localizing package metadata in Extension Manager" #8987

Merged
merged 14 commits into from
Sep 19, 2014
Merged

fix Issue #8953- "Localizing package metadata in Extension Manager" #8987

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
7cf0b40
fix Issue #8953- add Extension Manager support for localized extensio…
bchintx Sep 5, 2014
8d47643
update localization example for reference
bchintx Sep 5, 2014
d08d557
update localization readme for reference
bchintx Sep 5, 2014
fbf682e
as requested per code review
bchintx Sep 6, 2014
dd6d579
changes per code review
bchintx Sep 6, 2014
019edbb
Merge remote-tracking branch 'origin/master' into bchin/localize-pack…
bchintx Sep 6, 2014
da86d28
per code review, overlay first by shortlang, then by lang.
bchintx Sep 10, 2014
6aa3cea
Merge remote-tracking branch 'origin' into bchin/localize-package-met…
bchintx Sep 11, 2014
cb01a98
whitelisting properties to overlay; remove keyword concatenation with…
bchintx Sep 12, 2014
a7c8238
add top-level key to package.json to avoid collisions
bchintx Sep 12, 2014
117b20c
changes per code review
bchintx Sep 15, 2014
05d802d
adding unit tests
bchintx Sep 15, 2014
8fddc38
changes as requested per code review
bchintx Sep 19, 2014
c973447
Further consolidate duplicated code in a unit test
peterflynn Sep 19, 2014
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
24 changes: 20 additions & 4 deletions src/extensibility/ExtensionManagerView.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@
define(function (require, exports, module) {
"use strict";

var Strings = require("strings"),
var _ = require("thirdparty/lodash"),
Copy link
Member

Choose a reason for hiding this comment

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

Nit: no longer required

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Whoops. Nice catch.

Strings = require("strings"),
StringUtils = require("utils/StringUtils"),
ExtensionManager = require("extensibility/ExtensionManager"),
registry_utils = require("extensibility/registry_utils"),
Expand Down Expand Up @@ -211,6 +212,24 @@ define(function (require, exports, module) {
context.isCompatible = context.isCompatibleLatest = true;
}

// Extension metadata might have localized content. If so, overlay (or concatenate) those strings.
var lang = brackets.getLocale(),
shortLang = lang.split("-")[0],
useShortLang = info.metadata.hasOwnProperty(shortLang);
if (useShortLang || info.metadata.hasOwnProperty(lang)) {
var key = useShortLang ? shortLang : lang;
Copy link
Contributor

Choose a reason for hiding this comment

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

I think that we should replace the properties for both the short and the long language. Lets say that for some reason the title and description are in Spanish, so I then provide a title and description for "en", and I also provide just a title for "en-uk". If the language is "en-uk" we could first replace the title and description from "en" (as it is the shortLang) and then replace the title from "en-uk".

[shortLang, lang].forEach(function (locale) {
    if (info.metadata.hasOwnProperty(locale)) {
        _.forEach(info.metadata[locale], function (value, prop) {
            // Do the replacement ...
        });
    }
});

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh? I hadn't encountered that before, so thanks for the suggestion. I'll add that.

_.forEach(info.metadata[key], function (value, prop) {
if (prop !== "keywords") {
// overlay existing string w/ localized string
info.metadata[prop] = info.metadata[key][prop];
Copy link
Contributor

Choose a reason for hiding this comment

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

You can now use value instead of info.metadata[key][prop]. Same below.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah, good catch! Will do.

} else {
// for keywords, add the localized keywords to the root language keywords
var keywords = info.metadata[prop].concat(info.metadata[key][prop]);
info.metadata[prop] = _.uniq(keywords);
}
Copy link
Member

Choose a reason for hiding this comment

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

Is it safe to remove these? I still see them being referenced on the lines below:

userLangIndex = locales.indexOf(lang);
userLangIndex = locales.indexOf(shortLang);

Copy link
Member

Choose a reason for hiding this comment

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

Oh nm, I didn't see that this was in the same function scope. Sigh, GitHub diffs...

});
}

if (info.metadata.description !== undefined) {
info.metadata.shortdescription = StringUtils.truncate(info.metadata.description, 200);
}
Expand All @@ -224,9 +243,6 @@ define(function (require, exports, module) {
context.allowInstall = context.isCompatible && !context.isInstalled;

if (Array.isArray(info.metadata.i18n) && info.metadata.i18n.length > 0) {
var lang = brackets.getLocale(),
shortLang = lang.split("-")[0];

context.translated = true;
context.translatedLangs =
info.metadata.i18n.map(function (value) {
Expand Down
2 changes: 1 addition & 1 deletion src/extensions/samples/LocalizationExample/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Move this plugin to the extensions\user\ folder to run the plugin. It will add a

* main.js – loads the Strings module for the plugin and uses mustache to localize html content

* package.json - add the translation languages as in the example: `"i18n: ["en", "fr" ]`
* package.json - add the translation languages as in the example: `"i18n: ["en", "fr" ]`. Also, add any localized metadata for displayed metadata in the Extension Manager, as in the example: `"fr": { "title": "localized title" }`.
Copy link
Member

Choose a reason for hiding this comment

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

In my proposed changes in #9028, this text is basically going away. It's most important to update the official package.json format docs, though.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Gotcha. Once this is merged, I can definitely update the official docs.


* strings.js – uses i18n to load a strings.js file in the nls folder

Expand Down
6 changes: 5 additions & 1 deletion src/extensions/samples/LocalizationExample/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,9 @@
"i18n": [
"en",
"fr"
]
],
"fr": {
"title": "fr title to replace the root title",
"description": "fr description to replace the root description"
}
Copy link
Member

Choose a reason for hiding this comment

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

Nit: in the rest of this example, we used actual French translation. Google Translate should suffice...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point. Will do.

}