Merge pull request #42 from edx/albemarle/different-diff

fix(i18n): make detect_changed_source_translations work for both push and pull jobs

.babelrc

@@ -19,7 +19,7 @@
     "i18n": {
       "plugins": [
         ["react-intl", {
-          "messagesDir": "./temp",
+          "messagesDir": "./temp/babel-plugin-react-intl",
           "moduleSourceName": "@edx/frontend-i18n"
         }]
       ]

.gitignore

@@ -6,3 +6,4 @@ temp
 .idea/
 
 src/i18n/transifex_input.json
+temp/babel-plugin-react-intl

Makefile

@@ -1,41 +1,50 @@
+transifex_resource = frontend-component-footer
+transifex_langs = "ar,fr,es_419,zh_CN"
+
+transifex_utils = ./node_modules/.bin/transifex-utils.js
+i18n = ./src/i18n
+transifex_input = $(i18n)/transifex_input.json
+tx_url1 = https://www.transifex.com/api/2/project/edx-platform/resource/$(transifex_resource)/translation/en/strings/
+tx_url2 = https://www.transifex.com/api/2/project/edx-platform/resource/$(transifex_resource)/source/
+
+# This directory must match .babelrc .
+transifex_temp = ./temp/babel-plugin-react-intl
+
 requirements:
 	npm install
 
 i18n.extract:
-    # Pulling display strings from .jsx files into .json files...
+	# Pulling display strings from .jsx files into .json files...
+	rm -rf $(transifex_temp)
 	npm run-script i18n_extract
 
 i18n.concat:
-    # Gathering JSON messages into one file...
-	./src/i18n/i18n-concat.js ./temp/src ./src/i18n/transifex_input.json
-
-
-# The following make targets are required by our tooling scripts found in:
-# - https://github.com/edx/ecommerce-scripts/tree/master/transifex
+	# Gathering JSON messages into one file...
+	$(transifex_utils) $(transifex_temp) $(transifex_input)
 
 extract_translations: | requirements i18n.extract i18n.concat
 
+# Despite the name, we actually need this target to detect changes in the incoming translated message files as well.
 detect_changed_source_translations:
-	git diff --exit-code ./src/i18n/transifex_input.json
+	# Checking for changed translations...
+	git diff --exit-code $(i18n)
 
-tx_url1 = https://www.transifex.com/api/2/project/edx-platform/resource/frontend-component-footer/translation/en/strings/
-tx_url2 = https://www.transifex.com/api/2/project/edx-platform/resource/frontend-component-footer/source/
-
-# push translations to Transifex, doing magic so we can include the translator comments
-# Note: extract_translations is a prereq that our translation script calls separately.
+# Pushes translations to Transifex.  You must run make extract_translations first.
 push_translations:
+	# Pushing strings to Transifex...
 	tx push -s
-	# Adding translator comments...
-	# Fetching strings from Transifex...
+	# Fetching hashes from Transifex...
 	./node_modules/reactifex/bash_scripts/get_hashed_strings.sh $(tx_url1)
-    # Writing out comments to file...
-	./src/i18n/i18n-concat.js ./temp/src --comments
-    # Adding comments to Transifex...
+	# Writing out comments to file...
+	$(transifex_utils) $(transifex_temp) --comments
+	# Pushing comments to Transifex...
 	./node_modules/reactifex/bash_scripts/put_comments.sh $(tx_url2)
 
-# pull translations from Transifex
-pull_translations: ## must be exactly this name for edx tooling support, see ecommerce-scripts/transifex/pull.py
-	tx pull -f --mode reviewed --language="ar,fr,es_419,zh_CN"
+# Pulls translations from Transifex.
+pull_translations:
+	tx pull -f --mode reviewed --language=$(transifex_langs)
 
+# This target is used by Travis.
 validate-no-uncommitted-package-lock-changes:
+	# Checking for package-lock.json changes...
 	git diff --exit-code package-lock.json

package.json

@@ -41,7 +41,7 @@
     "@commitlint/prompt": "^6.0.2",
     "@commitlint/prompt-cli": "^6.0.2",
     "@edx/edx-bootstrap": "^2.2.1",
-    "@edx/frontend-i18n": "^1.0.4",
+    "@edx/frontend-i18n": "^2.1.0",
     "@edx/frontend-logging": "^2.0.2",
     "@edx/paragon": "^4.2.4",
     "@fortawesome/fontawesome-svg-core": "^1.2.17",
@@ -94,7 +94,7 @@
     "query-string": "^5.1.1"
   },
   "peerDependencies": {
-    "@edx/frontend-i18n": "^1.0.4",
+    "@edx/frontend-i18n": "^2.1.0",
     "@edx/frontend-logging": "^2.0.2",
     "@edx/paragon": "^4.2.4",
     "prop-types": "^15.5.10",

src/i18n/i18n-concat.js

@@ -1,65 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * See the Makefile for how the required hash file is downloaded from Transifex.
- */
-
-// NOTE: This script is called from Jenkins using devDependencies, so eslint is being
-// disabled so it doesn't force you to make these real dependencies.
-const fs = require('fs'); // eslint-disable-line import/no-extraneous-dependencies
-const glob = require('glob'); // eslint-disable-line import/no-extraneous-dependencies
-const path = require('path'); // eslint-disable-line import/no-extraneous-dependencies
-
-// Expected input: a directory, possibly containing subdirectories, with .json files.  Each .json
-// file is an array of translation triplets (id, description, defaultMessage).
-function gatherJson(dir) {
-  const ret = [];
-  const files = glob.sync(`${dir}/**/*.json`);
-
-  files.forEach((filename) => {
-    const messages = JSON.parse(fs.readFileSync(filename));
-    ret.push(...messages);
-  });
-  return ret;
-}
-
-// the hash file returns ids whose periods are "escaped" (sort of), like this:
-// "key": "profile\\.sociallinks\\.social\\.links"
-// so our regular messageIds won't match them out of the box
-function escapeDots(messageId) {
-  return messageId.replace(/\./g, '\\.');
-}
-
-const jsonDir = process.argv[2];
-const messageObjects = gatherJson(jsonDir);
-
-if (process.argv[3] === '--comments') { // prepare to handle the translator notes
-  const loggingPrefix = path.basename(`${__filename}`); // the name of this JS file
-  const bashScriptsPath = './node_modules/reactifex/bash_scripts';
-
-  const hashFile = `${bashScriptsPath}/hashmap.json`;
-  process.stdout.write(`${loggingPrefix}: reading hash file ${hashFile}\n`);
-  const messageInfo = JSON.parse(fs.readFileSync(hashFile));
-
-  const outputFile = `${bashScriptsPath}/hashed_data.txt`;
-  process.stdout.write(`${loggingPrefix}: writing to output file ${outputFile}\n`);
-  fs.writeFileSync(outputFile, '');
-
-  messageObjects.forEach((message) => {
-    const transifexFormatId = escapeDots(message.id);
-
-    const info = messageInfo.find(mi => mi.key === transifexFormatId);
-    if (info) {
-      fs.appendFileSync(outputFile, `${info.string_hash}|${message.description}\n`);
-    } else {
-      process.stdout.write(`${loggingPrefix}: string ${message.id} does not yet exist on transifex!\n`);
-    }
-  });
-} else {
-  const output = {};
-
-  messageObjects.forEach((message) => {
-    output[message.id] = message.defaultMessage;
-  });
-  fs.writeFileSync(process.argv[3], JSON.stringify(output, null, 2));
-}

src/i18n/index.js

@@ -0,0 +1,32 @@
+import arMessages from './messages/ar.json';
+import caMessages from './messages/ca.json';
+// no need to import en messages-- they are in the defaultMessage field
+import es419Messages from './messages/es_419.json';
+import frMessages from './messages/fr.json';
+import zhcnMessages from './messages/zh_CN.json';
+import heMessages from './messages/he.json';
+import idMessages from './messages/id.json';
+import kokrMessages from './messages/ko_kr.json';
+import plMessages from './messages/pl.json';
+import ptbrMessages from './messages/pt_br.json';
+import ruMessages from './messages/ru.json';
+import thMessages from './messages/th.json';
+import ukMessages from './messages/uk.json';
+
+const messages = {
+  ar: arMessages,
+  'es-419': es419Messages,
+  fr: frMessages,
+  'zh-cn': zhcnMessages,
+  ca: caMessages,
+  he: heMessages,
+  id: idMessages,
+  'ko-kr': kokrMessages,
+  pl: plMessages,
+  'pt-br': ptbrMessages,
+  ru: ruMessages,
+  th: thMessages,
+  uk: ukMessages,
+};
+
+export default messages;

src/i18n/messages/ar.json

@@ -1,39 +1 @@
-{
-  "footer.site-footer.link.business": "{siteName} for Business",
-  "footer.site-footer.link.about": "About",
-  "footer.site-footer.link.affiliates": "Affiliates",
-  "footer.site-footer.link.open-source": "Open {siteName}",
-  "footer.site-footer.link.careers": "Careers",
-  "footer.site-footer.link.news": "News",
-  "footer.site-footer.link.header.legal": "Legal",
-  "footer.site-footer.link.terms-of-service": "Terms of Service & Honor Code",
-  "footer.site-footer.link.privacy": "Privacy Policy",
-  "footer.site-footer.link.accessibility": "Accessibility Policy",
-  "footer.site-footer.link.trademark": "Trademark Policy",
-  "footer.site-footer.link.sitemap": "Sitemap",
-  "footer.site-footer.link.header.connect": "Connect",
-  "footer.site-footer.link.blog": "Blog",
-  "footer.site-footer.link.contact-us": "Contact Us",
-  "footer.site-footer.link.help-center": "Help Center",
-  "footer.site-footer.link.media-kit": "Media Kit",
-  "footer.site-footer.link.donate": "Donate",
-  "footer.site-footer.copyright-text": "{copyrightSymbol} {startDate}–{endDate} {siteName} Inc.",
-  "footer.site-footer.trademark-text": "EdX, Open edX, and MicroMasters are registered trademarks of edX Inc. | 深圳市恒宇博科技有限公司 {icpLicense}",
-  "footer.site-footer.site-logo.alt-text": "{siteName} logo",
-  "footer.site-footer.site-logo.aria-label": "{siteName} Home",
-  "footer.site-footer.facebook.title": "Facebook",
-  "footer.site-footer.facebook.screen-reader-text": "Like {siteName} on Facebook",
-  "footer.site-footer.twitter.title": "Twitter",
-  "footer.site-footer.twitter.screen-reader-text": "Follow {siteName} on Twitter",
-  "footer.site-footer.youtube.title": "Youtube",
-  "footer.site-footer.youtube.screen-reader-text": "Subscribe to the {siteName} YouTube channel",
-  "footer.site-footer.linkedin.title": "LinkedIn",
-  "footer.site-footer.linkedin.screen-reader-text": "Follow {siteName} on LinkedIn",
-  "footer.site-footer.google-plus.title": "Google+",
-  "footer.site-footer.google-plus.screen-reader-text": "Follow {siteName} on Google+",
-  "footer.site-footer.reddit.title": "Reddit",
-  "footer.site-footer.reddit.screen-reader-text": "Subscribe to the {siteName} subreddit",
-  "footer.site-footer.apple-app-store.alt-text": "Download the {siteName} mobile app from the Apple App Store",
-  "footer.site-footer.google-play.alt-text": "Download the {siteName} mobile app from Google Play",
-  "footer.site-footer.footer.aria-label": "Page Footer"
-}
+{}

src/i18n/messages/ca.json

@@ -0,0 +1 @@
+{}

src/i18n/messages/es_419.json

@@ -1,39 +1 @@
-{
-  "footer.site-footer.link.business": "{siteName} for Business",
-  "footer.site-footer.link.about": "About",
-  "footer.site-footer.link.affiliates": "Affiliates",
-  "footer.site-footer.link.open-source": "Open {siteName}",
-  "footer.site-footer.link.careers": "Careers",
-  "footer.site-footer.link.news": "News",
-  "footer.site-footer.link.header.legal": "Legal",
-  "footer.site-footer.link.terms-of-service": "Terms of Service & Honor Code",
-  "footer.site-footer.link.privacy": "Privacy Policy",
-  "footer.site-footer.link.accessibility": "Accessibility Policy",
-  "footer.site-footer.link.trademark": "Trademark Policy",
-  "footer.site-footer.link.sitemap": "Sitemap",
-  "footer.site-footer.link.header.connect": "Connect",
-  "footer.site-footer.link.blog": "Blog",
-  "footer.site-footer.link.contact-us": "Contact Us",
-  "footer.site-footer.link.help-center": "Help Center",
-  "footer.site-footer.link.media-kit": "Media Kit",
-  "footer.site-footer.link.donate": "Donate",
-  "footer.site-footer.copyright-text": "{copyrightSymbol} {startDate}–{endDate} {siteName} Inc.",
-  "footer.site-footer.trademark-text": "EdX, Open edX, and MicroMasters are registered trademarks of edX Inc. | 深圳市恒宇博科技有限公司 {icpLicense}",
-  "footer.site-footer.site-logo.alt-text": "{siteName} logo",
-  "footer.site-footer.site-logo.aria-label": "{siteName} Home",
-  "footer.site-footer.facebook.title": "Facebook",
-  "footer.site-footer.facebook.screen-reader-text": "Like {siteName} on Facebook",
-  "footer.site-footer.twitter.title": "Twitter",
-  "footer.site-footer.twitter.screen-reader-text": "Follow {siteName} on Twitter",
-  "footer.site-footer.youtube.title": "Youtube",
-  "footer.site-footer.youtube.screen-reader-text": "Subscribe to the {siteName} YouTube channel",
-  "footer.site-footer.linkedin.title": "LinkedIn",
-  "footer.site-footer.linkedin.screen-reader-text": "Follow {siteName} on LinkedIn",
-  "footer.site-footer.google-plus.title": "Google+",
-  "footer.site-footer.google-plus.screen-reader-text": "Follow {siteName} on Google+",
-  "footer.site-footer.reddit.title": "Reddit",
-  "footer.site-footer.reddit.screen-reader-text": "Subscribe to the {siteName} subreddit",
-  "footer.site-footer.apple-app-store.alt-text": "Download the {siteName} mobile app from the Apple App Store",
-  "footer.site-footer.google-play.alt-text": "Download the {siteName} mobile app from Google Play",
-  "footer.site-footer.footer.aria-label": "Page Footer"
-}
+{}

src/i18n/messages/fr.json

@@ -1,39 +1 @@
-{
-  "footer.site-footer.link.business": "{siteName} for Business",
-  "footer.site-footer.link.about": "About",
-  "footer.site-footer.link.affiliates": "Affiliates",
-  "footer.site-footer.link.open-source": "Open {siteName}",
-  "footer.site-footer.link.careers": "Careers",
-  "footer.site-footer.link.news": "News",
-  "footer.site-footer.link.header.legal": "Legal",
-  "footer.site-footer.link.terms-of-service": "Terms of Service & Honor Code",
-  "footer.site-footer.link.privacy": "Privacy Policy",
-  "footer.site-footer.link.accessibility": "Accessibility Policy",
-  "footer.site-footer.link.trademark": "Trademark Policy",
-  "footer.site-footer.link.sitemap": "Sitemap",
-  "footer.site-footer.link.header.connect": "Connect",
-  "footer.site-footer.link.blog": "Blog",
-  "footer.site-footer.link.contact-us": "Contact Us",
-  "footer.site-footer.link.help-center": "Help Center",
-  "footer.site-footer.link.media-kit": "Media Kit",
-  "footer.site-footer.link.donate": "Donate",
-  "footer.site-footer.copyright-text": "{copyrightSymbol} {startDate}–{endDate} {siteName} Inc.",
-  "footer.site-footer.trademark-text": "EdX, Open edX, and MicroMasters are registered trademarks of edX Inc. | 深圳市恒宇博科技有限公司 {icpLicense}",
-  "footer.site-footer.site-logo.alt-text": "{siteName} logo",
-  "footer.site-footer.site-logo.aria-label": "{siteName} Home",
-  "footer.site-footer.facebook.title": "Facebook",
-  "footer.site-footer.facebook.screen-reader-text": "Like {siteName} on Facebook",
-  "footer.site-footer.twitter.title": "Twitter",
-  "footer.site-footer.twitter.screen-reader-text": "Follow {siteName} on Twitter",
-  "footer.site-footer.youtube.title": "Youtube",
-  "footer.site-footer.youtube.screen-reader-text": "Subscribe to the {siteName} YouTube channel",
-  "footer.site-footer.linkedin.title": "LinkedIn",
-  "footer.site-footer.linkedin.screen-reader-text": "Follow {siteName} on LinkedIn",
-  "footer.site-footer.google-plus.title": "Google+",
-  "footer.site-footer.google-plus.screen-reader-text": "Follow {siteName} on Google+",
-  "footer.site-footer.reddit.title": "Reddit",
-  "footer.site-footer.reddit.screen-reader-text": "Subscribe to the {siteName} subreddit",
-  "footer.site-footer.apple-app-store.alt-text": "Download the {siteName} mobile app from the Apple App Store",
-  "footer.site-footer.google-play.alt-text": "Download the {siteName} mobile app from Google Play",
-  "footer.site-footer.footer.aria-label": "Page Footer"
-}
+{}

src/i18n/messages/he.json

@@ -0,0 +1 @@
+{}

src/i18n/messages/id.json

@@ -0,0 +1 @@
+{}

src/i18n/messages/ko_kr.json

@@ -0,0 +1 @@
+{}

src/i18n/messages/pl.json

@@ -0,0 +1 @@
+{}

src/i18n/messages/pt_br.json

@@ -0,0 +1 @@
+{}

src/i18n/messages/ru.json

@@ -0,0 +1 @@
+{}

src/i18n/messages/th.json

@@ -0,0 +1 @@
+{}

src/i18n/messages/uk.json

@@ -0,0 +1 @@
+{}

src/i18n/messages/zh_CN.json

@@ -1,39 +1 @@
-{
-  "footer.site-footer.link.business": "商用{siteName} ",
-  "footer.site-footer.link.about": "关于",
-  "footer.site-footer.link.affiliates": "附属机构",
-  "footer.site-footer.link.open-source": "打开{siteName}",
-  "footer.site-footer.link.careers": "招才纳贤",
-  "footer.site-footer.link.news": "新闻",
-  "footer.site-footer.link.header.legal": "法律条款",
-  "footer.site-footer.link.terms-of-service": "服务条款 & 荣誉准则",
-  "footer.site-footer.link.privacy": "隐私政策",
-  "footer.site-footer.link.accessibility": "可访问策略",
-  "footer.site-footer.link.trademark": "商标政策",
-  "footer.site-footer.link.sitemap": "网站导航",
-  "footer.site-footer.link.header.connect": "连接",
-  "footer.site-footer.link.blog": "博客",
-  "footer.site-footer.link.contact-us": "联系我们",
-  "footer.site-footer.link.help-center": "帮助中心",
-  "footer.site-footer.link.media-kit": "多媒体工具箱",
-  "footer.site-footer.link.donate": "捐献",
-  "footer.site-footer.copyright-text": "{copyrightSymbol} {startDate}–{endDate} {siteName} Inc.",
-  "footer.site-footer.trademark-text": "EdX, Open edX, and MicroMasters are registered trademarks of edX Inc. | 深圳市恒宇博科技有限公司 {icpLicense}",
-  "footer.site-footer.site-logo.alt-text": "{siteName} logo",
-  "footer.site-footer.site-logo.aria-label": "{siteName} 主页",
-  "footer.site-footer.facebook.title": "脸书",
-  "footer.site-footer.facebook.screen-reader-text": "在Facebook上为 {siteName}点赞",
-  "footer.site-footer.twitter.title": "推特",
-  "footer.site-footer.twitter.screen-reader-text": "在Twitter上关注 {siteName}",
-  "footer.site-footer.youtube.title": "Youtube",
-  "footer.site-footer.youtube.screen-reader-text": "订阅{siteName} YouTube频道",
-  "footer.site-footer.linkedin.title": "LinkedIn",
-  "footer.site-footer.linkedin.screen-reader-text": "在LinkedIn上关注{siteName}",
-  "footer.site-footer.google-plus.title": "Google+",
-  "footer.site-footer.google-plus.screen-reader-text": "在Google+上关注{siteName} ",
-  "footer.site-footer.reddit.title": "Reddit",
-  "footer.site-footer.reddit.screen-reader-text": "订阅{siteName} subreddit",
-  "footer.site-footer.apple-app-store.alt-text": "从Apple App Store下载 {siteName} 的移动客户端",
-  "footer.site-footer.google-play.alt-text": "从Google Play下载 {siteName} 的移动客户端",
-  "footer.site-footer.footer.aria-label": "页脚"
-}
+{}