Fix Bug 1497565 - Rename locales to locales-src to avoid accidentall…

…y exporting l10n-exposed strings (#4506)
mozilla · Oct 17, 2018 · 0fb3f8c · 0fb3f8c
1 parent d9b7367
commit 0fb3f8c
Show file tree

Hide file tree

Showing 103 changed files with 20 additions and 9 deletions.
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -1,2 +1,2 @@
 # flod as main contact for string changes
-locales/en-US/strings.properties @flodolo
+locales-src/en-US/strings.properties @flodolo
diff --git a/bin/locales.js b/bin/locales.js
@@ -1,4 +1,10 @@
-exports.DEFAULT_LOCALE = "en-US";
+if (!process.env.npm_lifecycle_event) {
+  throw Error("You should only run this from npm script contexts");
+}
+
+exports.DEFAULT_LOCALE = process.env.npm_package_config_default_locale;
+
+exports.LOCALES_SOURCE_DIRECTORY = process.env.npm_package_config_locales_dir;
 
 // This locales list is to find any similar locales that we can reuse strings
 // instead of falling back to the default, e.g., use bn-BD strings for bn-IN.

diff --git a/bin/strings-import.js b/bin/strings-import.js
@@ -7,7 +7,7 @@ const fetch = require("node-fetch");
 /* globals cd, ls, mkdir, rm, ShellString */
 require("shelljs/global");
 
-const {CENTRAL_LOCALES, DEFAULT_LOCALE} = require("./locales");
+const {CENTRAL_LOCALES, DEFAULT_LOCALE, LOCALES_SOURCE_DIRECTORY} = require("./locales");
 const L10N_CENTRAL = "https://hg.mozilla.org/l10n-central";
 const PROPERTIES_PATH = "raw-file/default/browser/chrome/browser/activity-stream/newtab.properties";
 const STRINGS_FILE = "strings.properties";
@@ -74,9 +74,9 @@ async function saveProperties(locale) {
 
 // Replace and update each locale's strings
 async function updateLocales() {
-  console.log("Switching to and deleting existing l10n tree under: locales");
+  console.log(`Switching to and deleting existing l10n tree under: ${LOCALES_SOURCE_DIRECTORY}`);
 
-  cd("locales");
+  cd(LOCALES_SOURCE_DIRECTORY);
   ls().forEach(dir => {
     // Keep the default/source locale as it might have newer strings
     if (dir !== DEFAULT_LOCALE) {

diff --git a/locales/ach/strings.properties → locales-src/ach/strings.properties b/locales/ach/strings.properties → locales-src/ach/strings.properties
diff --git a/locales/an/strings.properties → locales-src/an/strings.properties b/locales/an/strings.properties → locales-src/an/strings.properties
diff --git a/locales/ar/strings.properties → locales-src/ar/strings.properties b/locales/ar/strings.properties → locales-src/ar/strings.properties
diff --git a/locales/ast/strings.properties → locales-src/ast/strings.properties b/locales/ast/strings.properties → locales-src/ast/strings.properties
diff --git a/locales/az/strings.properties → locales-src/az/strings.properties b/locales/az/strings.properties → locales-src/az/strings.properties
diff --git a/locales/be/strings.properties → locales-src/be/strings.properties b/locales/be/strings.properties → locales-src/be/strings.properties
diff --git a/locales/bg/strings.properties → locales-src/bg/strings.properties b/locales/bg/strings.properties → locales-src/bg/strings.properties
diff --git a/locales/bn-BD/strings.properties → locales-src/bn-BD/strings.properties b/locales/bn-BD/strings.properties → locales-src/bn-BD/strings.properties
diff --git a/locales/bn-IN/strings.properties → locales-src/bn-IN/strings.properties b/locales/bn-IN/strings.properties → locales-src/bn-IN/strings.properties
diff --git a/locales/br/strings.properties → locales-src/br/strings.properties b/locales/br/strings.properties → locales-src/br/strings.properties
diff --git a/locales/bs/strings.properties → locales-src/bs/strings.properties b/locales/bs/strings.properties → locales-src/bs/strings.properties
diff --git a/locales/ca/strings.properties → locales-src/ca/strings.properties b/locales/ca/strings.properties → locales-src/ca/strings.properties
diff --git a/locales/cak/strings.properties → locales-src/cak/strings.properties b/locales/cak/strings.properties → locales-src/cak/strings.properties
diff --git a/locales/crh/strings.properties → locales-src/crh/strings.properties b/locales/crh/strings.properties → locales-src/crh/strings.properties
diff --git a/locales/cs/strings.properties → locales-src/cs/strings.properties b/locales/cs/strings.properties → locales-src/cs/strings.properties
diff --git a/locales/cy/strings.properties → locales-src/cy/strings.properties b/locales/cy/strings.properties → locales-src/cy/strings.properties
diff --git a/locales/da/strings.properties → locales-src/da/strings.properties b/locales/da/strings.properties → locales-src/da/strings.properties
diff --git a/locales/de/strings.properties → locales-src/de/strings.properties b/locales/de/strings.properties → locales-src/de/strings.properties
diff --git a/locales/dsb/strings.properties → locales-src/dsb/strings.properties b/locales/dsb/strings.properties → locales-src/dsb/strings.properties
diff --git a/locales/el/strings.properties → locales-src/el/strings.properties b/locales/el/strings.properties → locales-src/el/strings.properties
diff --git a/locales/en-CA/strings.properties → locales-src/en-CA/strings.properties b/locales/en-CA/strings.properties → locales-src/en-CA/strings.properties
diff --git a/locales/en-GB/strings.properties → locales-src/en-GB/strings.properties b/locales/en-GB/strings.properties → locales-src/en-GB/strings.properties
diff --git a/locales/en-US/strings.properties → locales-src/en-US/strings.properties b/locales/en-US/strings.properties → locales-src/en-US/strings.properties
diff --git a/locales/eo/strings.properties → locales-src/eo/strings.properties b/locales/eo/strings.properties → locales-src/eo/strings.properties
diff --git a/locales/es-AR/strings.properties → locales-src/es-AR/strings.properties b/locales/es-AR/strings.properties → locales-src/es-AR/strings.properties
diff --git a/locales/es-CL/strings.properties → locales-src/es-CL/strings.properties b/locales/es-CL/strings.properties → locales-src/es-CL/strings.properties
diff --git a/locales/es-ES/strings.properties → locales-src/es-ES/strings.properties b/locales/es-ES/strings.properties → locales-src/es-ES/strings.properties
diff --git a/locales/es-MX/strings.properties → locales-src/es-MX/strings.properties b/locales/es-MX/strings.properties → locales-src/es-MX/strings.properties
diff --git a/locales/et/strings.properties → locales-src/et/strings.properties b/locales/et/strings.properties → locales-src/et/strings.properties
diff --git a/locales/eu/strings.properties → locales-src/eu/strings.properties b/locales/eu/strings.properties → locales-src/eu/strings.properties
diff --git a/locales/fa/strings.properties → locales-src/fa/strings.properties b/locales/fa/strings.properties → locales-src/fa/strings.properties
diff --git a/locales/ff/strings.properties → locales-src/ff/strings.properties b/locales/ff/strings.properties → locales-src/ff/strings.properties
diff --git a/locales/fi/strings.properties → locales-src/fi/strings.properties b/locales/fi/strings.properties → locales-src/fi/strings.properties
diff --git a/locales/fr/strings.properties → locales-src/fr/strings.properties b/locales/fr/strings.properties → locales-src/fr/strings.properties
diff --git a/locales/fy-NL/strings.properties → locales-src/fy-NL/strings.properties b/locales/fy-NL/strings.properties → locales-src/fy-NL/strings.properties
diff --git a/locales/ga-IE/strings.properties → locales-src/ga-IE/strings.properties b/locales/ga-IE/strings.properties → locales-src/ga-IE/strings.properties
diff --git a/locales/gd/strings.properties → locales-src/gd/strings.properties b/locales/gd/strings.properties → locales-src/gd/strings.properties
diff --git a/locales/gl/strings.properties → locales-src/gl/strings.properties b/locales/gl/strings.properties → locales-src/gl/strings.properties
diff --git a/locales/gn/strings.properties → locales-src/gn/strings.properties b/locales/gn/strings.properties → locales-src/gn/strings.properties
diff --git a/locales/gu-IN/strings.properties → locales-src/gu-IN/strings.properties b/locales/gu-IN/strings.properties → locales-src/gu-IN/strings.properties
diff --git a/locales/he/strings.properties → locales-src/he/strings.properties b/locales/he/strings.properties → locales-src/he/strings.properties
diff --git a/locales/hi-IN/strings.properties → locales-src/hi-IN/strings.properties b/locales/hi-IN/strings.properties → locales-src/hi-IN/strings.properties
diff --git a/locales/hr/strings.properties → locales-src/hr/strings.properties b/locales/hr/strings.properties → locales-src/hr/strings.properties
diff --git a/locales/hsb/strings.properties → locales-src/hsb/strings.properties b/locales/hsb/strings.properties → locales-src/hsb/strings.properties
diff --git a/locales/hu/strings.properties → locales-src/hu/strings.properties b/locales/hu/strings.properties → locales-src/hu/strings.properties
diff --git a/locales/hy-AM/strings.properties → locales-src/hy-AM/strings.properties b/locales/hy-AM/strings.properties → locales-src/hy-AM/strings.properties
diff --git a/locales/ia/strings.properties → locales-src/ia/strings.properties b/locales/ia/strings.properties → locales-src/ia/strings.properties
diff --git a/locales/id/strings.properties → locales-src/id/strings.properties b/locales/id/strings.properties → locales-src/id/strings.properties
diff --git a/locales/is/strings.properties → locales-src/is/strings.properties b/locales/is/strings.properties → locales-src/is/strings.properties
diff --git a/locales/it/strings.properties → locales-src/it/strings.properties b/locales/it/strings.properties → locales-src/it/strings.properties
diff --git a/locales/ja-JP-mac/strings.properties → locales-src/ja-JP-mac/strings.properties b/locales/ja-JP-mac/strings.properties → locales-src/ja-JP-mac/strings.properties
diff --git a/locales/ja/strings.properties → locales-src/ja/strings.properties b/locales/ja/strings.properties → locales-src/ja/strings.properties
diff --git a/locales/ka/strings.properties → locales-src/ka/strings.properties b/locales/ka/strings.properties → locales-src/ka/strings.properties
diff --git a/locales/kab/strings.properties → locales-src/kab/strings.properties b/locales/kab/strings.properties → locales-src/kab/strings.properties
diff --git a/locales/kk/strings.properties → locales-src/kk/strings.properties b/locales/kk/strings.properties → locales-src/kk/strings.properties
diff --git a/locales/km/strings.properties → locales-src/km/strings.properties b/locales/km/strings.properties → locales-src/km/strings.properties
diff --git a/locales/kn/strings.properties → locales-src/kn/strings.properties b/locales/kn/strings.properties → locales-src/kn/strings.properties
diff --git a/locales/ko/strings.properties → locales-src/ko/strings.properties b/locales/ko/strings.properties → locales-src/ko/strings.properties
diff --git a/locales/lij/strings.properties → locales-src/lij/strings.properties b/locales/lij/strings.properties → locales-src/lij/strings.properties
diff --git a/locales/lo/strings.properties → locales-src/lo/strings.properties b/locales/lo/strings.properties → locales-src/lo/strings.properties
diff --git a/locales/lt/strings.properties → locales-src/lt/strings.properties b/locales/lt/strings.properties → locales-src/lt/strings.properties
diff --git a/locales/ltg/strings.properties → locales-src/ltg/strings.properties b/locales/ltg/strings.properties → locales-src/ltg/strings.properties
diff --git a/locales/lv/strings.properties → locales-src/lv/strings.properties b/locales/lv/strings.properties → locales-src/lv/strings.properties
diff --git a/locales/mai/strings.properties → locales-src/mai/strings.properties b/locales/mai/strings.properties → locales-src/mai/strings.properties
diff --git a/locales/mk/strings.properties → locales-src/mk/strings.properties b/locales/mk/strings.properties → locales-src/mk/strings.properties
diff --git a/locales/ml/strings.properties → locales-src/ml/strings.properties b/locales/ml/strings.properties → locales-src/ml/strings.properties
diff --git a/locales/mr/strings.properties → locales-src/mr/strings.properties b/locales/mr/strings.properties → locales-src/mr/strings.properties
diff --git a/locales/ms/strings.properties → locales-src/ms/strings.properties b/locales/ms/strings.properties → locales-src/ms/strings.properties
diff --git a/locales/my/strings.properties → locales-src/my/strings.properties b/locales/my/strings.properties → locales-src/my/strings.properties
diff --git a/locales/nb-NO/strings.properties → locales-src/nb-NO/strings.properties b/locales/nb-NO/strings.properties → locales-src/nb-NO/strings.properties
diff --git a/locales/ne-NP/strings.properties → locales-src/ne-NP/strings.properties b/locales/ne-NP/strings.properties → locales-src/ne-NP/strings.properties
diff --git a/locales/nl/strings.properties → locales-src/nl/strings.properties b/locales/nl/strings.properties → locales-src/nl/strings.properties
diff --git a/locales/nn-NO/strings.properties → locales-src/nn-NO/strings.properties b/locales/nn-NO/strings.properties → locales-src/nn-NO/strings.properties
diff --git a/locales/oc/strings.properties → locales-src/oc/strings.properties b/locales/oc/strings.properties → locales-src/oc/strings.properties
diff --git a/locales/pa-IN/strings.properties → locales-src/pa-IN/strings.properties b/locales/pa-IN/strings.properties → locales-src/pa-IN/strings.properties
diff --git a/locales/pl/strings.properties → locales-src/pl/strings.properties b/locales/pl/strings.properties → locales-src/pl/strings.properties
diff --git a/locales/pt-BR/strings.properties → locales-src/pt-BR/strings.properties b/locales/pt-BR/strings.properties → locales-src/pt-BR/strings.properties
diff --git a/locales/pt-PT/strings.properties → locales-src/pt-PT/strings.properties b/locales/pt-PT/strings.properties → locales-src/pt-PT/strings.properties
diff --git a/locales/rm/strings.properties → locales-src/rm/strings.properties b/locales/rm/strings.properties → locales-src/rm/strings.properties
diff --git a/locales/ro/strings.properties → locales-src/ro/strings.properties b/locales/ro/strings.properties → locales-src/ro/strings.properties
diff --git a/locales/ru/strings.properties → locales-src/ru/strings.properties b/locales/ru/strings.properties → locales-src/ru/strings.properties
diff --git a/locales/si/strings.properties → locales-src/si/strings.properties b/locales/si/strings.properties → locales-src/si/strings.properties
diff --git a/locales/sk/strings.properties → locales-src/sk/strings.properties b/locales/sk/strings.properties → locales-src/sk/strings.properties
diff --git a/locales/sl/strings.properties → locales-src/sl/strings.properties b/locales/sl/strings.properties → locales-src/sl/strings.properties
diff --git a/locales/sq/strings.properties → locales-src/sq/strings.properties b/locales/sq/strings.properties → locales-src/sq/strings.properties
diff --git a/locales/sr/strings.properties → locales-src/sr/strings.properties b/locales/sr/strings.properties → locales-src/sr/strings.properties
diff --git a/locales/sv-SE/strings.properties → locales-src/sv-SE/strings.properties b/locales/sv-SE/strings.properties → locales-src/sv-SE/strings.properties
diff --git a/locales/ta/strings.properties → locales-src/ta/strings.properties b/locales/ta/strings.properties → locales-src/ta/strings.properties
diff --git a/locales/te/strings.properties → locales-src/te/strings.properties b/locales/te/strings.properties → locales-src/te/strings.properties
diff --git a/locales/th/strings.properties → locales-src/th/strings.properties b/locales/th/strings.properties → locales-src/th/strings.properties
diff --git a/locales/tl/strings.properties → locales-src/tl/strings.properties b/locales/tl/strings.properties → locales-src/tl/strings.properties
diff --git a/locales/tr/strings.properties → locales-src/tr/strings.properties b/locales/tr/strings.properties → locales-src/tr/strings.properties
diff --git a/locales/uk/strings.properties → locales-src/uk/strings.properties b/locales/uk/strings.properties → locales-src/uk/strings.properties
diff --git a/locales/ur/strings.properties → locales-src/ur/strings.properties b/locales/ur/strings.properties → locales-src/ur/strings.properties
diff --git a/locales/uz/strings.properties → locales-src/uz/strings.properties b/locales/uz/strings.properties → locales-src/uz/strings.properties
diff --git a/locales/vi/strings.properties → locales-src/vi/strings.properties b/locales/vi/strings.properties → locales-src/vi/strings.properties
diff --git a/locales/zh-CN/strings.properties → locales-src/zh-CN/strings.properties b/locales/zh-CN/strings.properties → locales-src/zh-CN/strings.properties
diff --git a/locales/zh-TW/strings.properties → locales-src/zh-TW/strings.properties b/locales/zh-TW/strings.properties → locales-src/zh-TW/strings.properties
diff --git a/package.json b/package.json
@@ -88,21 +88,26 @@
   "main": "bootstrap.js",
   "repository": "mozilla/activity-stream",
   "config": {
+    "default_locale": "en-US",
+    "/*": "NB: This directory is *not* 'locales' to avoid mercurial hook for uplifts.",
+    "**": "It contains the source default locale strings to be exported for localization",
+    "*/": "and is the path used to update translated strings and to prerender strings.",
+    "locales_dir": "locales-src",
     "mc_dir": "../mozilla-central"
   },
   "scripts": {
     "mochitest": "(cd $npm_package_config_mc_dir && ./mach mochitest browser/components/newtab/test/browser --headless)",
     "mochitest-debug": "(cd $npm_package_config_mc_dir && ./mach mochitest --jsdebugger browser/components/newtab/test/browser)",
     "bundle": "npm-run-all bundle:*",
-    "bundle:locales": "pontoon-to-json --src locales --dest data",
+    "bundle:locales": "pontoon-to-json --src $npm_package_config_locales_dir --dest data",
     "bundle:webpack": "webpack --config webpack.system-addon.config.js",
     "bundle:css": "node-sass --source-map true --source-map-contents content-src/styles -o css",
     "bundle:html": "rimraf prerendered && webpack --config webpack.prerender.config.js && node ./bin/render-activity-stream-html.js",
     "buildmc": "npm-run-all buildmc:*",
     "prebuildmc": "rimraf $npm_package_config_mc_dir/browser/components/newtab/",
     "buildmc:bundle": "npm run  bundle",
     "buildmc:copy": "rsync --exclude-from .mcignore -a . $npm_package_config_mc_dir/browser/components/newtab/",
-    "buildmc:stringsExport": "cp locales/en-US/strings.properties $npm_package_config_mc_dir/browser/locales/en-US/chrome/browser/activity-stream/newtab.properties",
+    "buildmc:stringsExport": "cp $npm_package_config_locales_dir/$npm_package_config_default_locale/strings.properties $npm_package_config_mc_dir/browser/locales/$npm_package_config_default_locale/chrome/browser/activity-stream/newtab.properties",
     "buildmc:copyPingCentre": "cpx \"ping-centre/PingCentre.jsm\" $npm_package_config_mc_dir/browser/modules",
     "startmc": "npm-run-all --parallel startmc:*",
     "prestartmc": "npm run buildmc",

diff --git a/yamscripts.yml b/yamscripts.yml
@@ -14,7 +14,7 @@ scripts:
 
 # bundle: Build all assets for activity stream
   bundle:
-    locales: pontoon-to-json --src locales --dest data
+    locales: pontoon-to-json --src $npm_package_config_locales_dir --dest data
     webpack: webpack --config webpack.system-addon.config.js
     css: node-sass --source-map true --source-map-contents content-src/styles -o css
     html: rimraf prerendered && webpack --config webpack.prerender.config.js && node ./bin/render-activity-stream-html.js
@@ -24,7 +24,7 @@ scripts:
     pre: rimraf $npm_package_config_mc_dir/browser/components/newtab/
     bundle: => bundle
     copy: rsync --exclude-from .mcignore -a . $npm_package_config_mc_dir/browser/components/newtab/
-    stringsExport: cp locales/en-US/strings.properties $npm_package_config_mc_dir/browser/locales/en-US/chrome/browser/activity-stream/newtab.properties
+    stringsExport: cp $npm_package_config_locales_dir/$npm_package_config_default_locale/strings.properties $npm_package_config_mc_dir/browser/locales/$npm_package_config_default_locale/chrome/browser/activity-stream/newtab.properties
     copyPingCentre: cpx "ping-centre/PingCentre.jsm" $npm_package_config_mc_dir/browser/modules
 
 # startmc: Start developing the bootstrapped add-on