From 94b3f19ed5f917e31573f8b32175c1aa4afd2cfe Mon Sep 17 00:00:00 2001 From: Adam Butterworth Date: Tue, 17 Sep 2019 11:37:26 -0400 Subject: [PATCH] feat: add i18n pipeline tools --- .gitignore | 2 ++ .tx/config | 8 +++++ Makefile | 59 ++++++++++++++++++++++++++++++++--- README.rst | 4 ++- babel.config.js | 11 +++++++ package.json | 16 +++++----- src/i18n/index.js | 18 +++++++++++ src/i18n/messages/ar.json | 2 ++ src/i18n/messages/es_419.json | 2 ++ src/i18n/messages/fr.json | 2 ++ src/i18n/messages/ko_KR.json | 2 ++ src/i18n/messages/pt_BR.json | 2 ++ src/i18n/messages/zh_CN.json | 2 ++ 13 files changed, 118 insertions(+), 12 deletions(-) create mode 100644 .tx/config create mode 100644 src/i18n/index.js create mode 100644 src/i18n/messages/ar.json create mode 100644 src/i18n/messages/es_419.json create mode 100644 src/i18n/messages/fr.json create mode 100644 src/i18n/messages/ko_KR.json create mode 100644 src/i18n/messages/pt_BR.json create mode 100644 src/i18n/messages/zh_CN.json diff --git a/.gitignore b/.gitignore index 4acc7960b..4f5273eee 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,5 @@ coverage dist node_modules +temp +src/i18n/transifex_input.json diff --git a/.tx/config b/.tx/config new file mode 100644 index 000000000..fd20ef2da --- /dev/null +++ b/.tx/config @@ -0,0 +1,8 @@ +[main] +host = https://www.transifex.com + +[edx-platform.frontend-component-header] +file_filter = src/i18n/messages/.json +source_file = src/i18n/transifex_input.json +source_lang = en +type = KEYVALUEJSON diff --git a/Makefile b/Makefile index f6a530129..2016d4d03 100644 --- a/Makefile +++ b/Makefile @@ -1,7 +1,58 @@ +transifex_resource = frontend-component-header +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 + build: rm -rf ./dist ./node_modules/.bin/babel src --out-dir dist --source-maps --ignore **/*.test.jsx,**/__mocks__,**/__snapshots__,**/setupTest.js --copy-files - # --copy-files will bring in everything else that wasn't processed by babel. Remove what we don't want. - rm -rf dist/**/*.test.jsx - rm -rf dist/**/__snapshots__ - rm -rf dist/__mocks__ + @# --copy-files will bring in everything else that wasn't processed by babel. Remove what we don't want. + @rm -rf dist/**/*.test.jsx + @rm -rf dist/**/__snapshots__ + @rm -rf dist/__mocks__ + +requirements: + npm install + +i18n.extract: + # 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... + $(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: + # Checking for changed translations... + git diff --exit-code $(i18n) + +# Pushes translations to Transifex. You must run make extract_translations first. +push_translations: + # Pushing strings to Transifex... + tx push -s + # Fetching hashes from Transifex... + ./node_modules/reactifex/bash_scripts/get_hashed_strings.sh $(tx_url1) + # Writing out comments to file... + $(transifex_utils) $(transifex_temp) --comments + # Pushing comments to Transifex... + ./node_modules/reactifex/bash_scripts/put_comments.sh $(tx_url2) + +# 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 diff --git a/README.rst b/README.rst index a2c671e10..a2b76277e 100644 --- a/README.rst +++ b/README.rst @@ -3,7 +3,9 @@ frontend-component-header |Build Status| |Codecov| |npm_version| |npm_downloads| |license| |semantic-release| -This repository is a work in progress. Nothing found here is at all production-ready. +This is the standard Open edX header for use in React applications. It has two exports: + - **default**: The Header Component + - **messages**: for i18n in the form of ``{ locale: { key: translatedString } }`` .. |Build Status| image:: https://api.travis-ci.org/edx/frontend-component-header.svg?branch=master-edx :target: https://travis-ci.org/edx/frontend-component-header diff --git a/babel.config.js b/babel.config.js index 91729008d..89cf18af2 100644 --- a/babel.config.js +++ b/babel.config.js @@ -13,6 +13,17 @@ module.exports = { '@babel/plugin-proposal-class-properties', ], env: { + i18n: { + plugins: [ + [ + 'react-intl', + { + messagesDir: './temp/babel-plugin-react-intl', + moduleSourceName: '@edx/frontend-i18n', + }, + ], + ], + }, test: { presets: [ '@babel/preset-env', diff --git a/package.json b/package.json index 39b2e4c96..c0e832145 100644 --- a/package.json +++ b/package.json @@ -1,13 +1,14 @@ { - "name": "@edx/frontend-component-header", + "name": "@edx/frontend-component-header-edx", "version": "1.0.0-semantically-released", - "description": "The standard header for Open edX", + "description": "The standard header for edX", "publishConfig": { "access": "public" }, "main": "dist/index.js", "scripts": { "build": "make build", + "i18n_extract": "BABEL_ENV=i18n babel src --quiet > /dev/null", "lint": "eslint --ext .js --ext .jsx .", "semantic-release": "semantic-release", "start": "parcel ./example/index.html --no-source-maps --out-dir example/dist", @@ -19,14 +20,14 @@ ], "repository": { "type": "git", - "url": "git+https://github.com/edx/frontend-component-header.git" + "url": "git+https://github.com/edx/frontend-component-header-edx.git" }, "author": "edX", "license": "AGPL-3.0", "bugs": { - "url": "https://github.com/edx/frontend-component-header/issues" + "url": "https://github.com/edx/frontend-component-header-edx/issues" }, - "homepage": "https://github.com/edx/frontend-component-header#readme", + "homepage": "https://github.com/edx/frontend-component-header-edx#readme", "devDependencies": { "@babel/cli": "^7.6.0", "@babel/core": "^7.6.0", @@ -34,13 +35,12 @@ "@babel/plugin-proposal-object-rest-spread": "^7.5.5", "@babel/preset-env": "^7.6.0", "@babel/preset-react": "^7.0.0", - "@edx/frontend-analytics": "^2.0.0", "@edx/frontend-auth": "^6.0.1", - "@edx/frontend-base": "^1.1.0", "@edx/frontend-i18n": "^3.0.2", "@edx/frontend-logging": "^3.0.1", "@edx/paragon": "^7.1.2", "babel-eslint": "^10.0.3", + "babel-plugin-react-intl": "^4.1.18", "dotenv": "^8.1.0", "enzyme": "^3.10.0", "eslint": "^6.3.0", @@ -53,12 +53,14 @@ "react-redux": "^7.1.1", "react-router-dom": "^5.0.1", "react-test-renderer": "^16.9.0", + "reactifex": "^1.1.1", "redux": "^4.0.4", "redux-saga": "^1.0.5", "sass": "^1.22.12", "semantic-release": "^15.13.24" }, "peerDependencies": { + "@edx/frontend-analytics": "^2.0.0", "@edx/frontend-base": "^1.1.0", "@edx/frontend-i18n": "^3.0.2", "prop-types": "^15.7.2", diff --git a/src/i18n/index.js b/src/i18n/index.js new file mode 100644 index 000000000..b9352f556 --- /dev/null +++ b/src/i18n/index.js @@ -0,0 +1,18 @@ +import arMessages from './messages/ar.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 kokrMessages from './messages/ko_KR.json'; +import ptbrMessages from './messages/pt_BR.json'; +import zhcnMessages from './messages/zh_CN.json'; + +const messages = { + ar: arMessages, + 'es-419': es419Messages, + fr: frMessages, + 'zh-cn': zhcnMessages, + 'ko-kr': kokrMessages, + 'pt-br': ptbrMessages, +}; + +export default messages; diff --git a/src/i18n/messages/ar.json b/src/i18n/messages/ar.json new file mode 100644 index 000000000..2c63c0851 --- /dev/null +++ b/src/i18n/messages/ar.json @@ -0,0 +1,2 @@ +{ +} diff --git a/src/i18n/messages/es_419.json b/src/i18n/messages/es_419.json new file mode 100644 index 000000000..2c63c0851 --- /dev/null +++ b/src/i18n/messages/es_419.json @@ -0,0 +1,2 @@ +{ +} diff --git a/src/i18n/messages/fr.json b/src/i18n/messages/fr.json new file mode 100644 index 000000000..2c63c0851 --- /dev/null +++ b/src/i18n/messages/fr.json @@ -0,0 +1,2 @@ +{ +} diff --git a/src/i18n/messages/ko_KR.json b/src/i18n/messages/ko_KR.json new file mode 100644 index 000000000..2c63c0851 --- /dev/null +++ b/src/i18n/messages/ko_KR.json @@ -0,0 +1,2 @@ +{ +} diff --git a/src/i18n/messages/pt_BR.json b/src/i18n/messages/pt_BR.json new file mode 100644 index 000000000..2c63c0851 --- /dev/null +++ b/src/i18n/messages/pt_BR.json @@ -0,0 +1,2 @@ +{ +} diff --git a/src/i18n/messages/zh_CN.json b/src/i18n/messages/zh_CN.json new file mode 100644 index 000000000..2c63c0851 --- /dev/null +++ b/src/i18n/messages/zh_CN.json @@ -0,0 +1,2 @@ +{ +}