@dydxprotocol/v4-localization 0.0.6

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@dydxprotocol/v4-localization",
+  "version": "0.0.6",
+  "description": "v4 localization",
+  "main": "index.ts",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dydxprotocol/v4-localization.git"
+  },
+  "author": "",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/dydxprotocol/v4-localization/issues"
+  },
+  "homepage": "https://github.com/dydxprotocol/v4-localization#readme",
+  "devDependencies": {
+    "@types/node": "^20.1.7"
+  }
+}

package/readme.md

@@ -0,0 +1,63 @@
+# Translation structures
+
+There are four folders for translations.
+
+/config/localization
+/config/localization_notifications
+/config/localizations_native
+/marketing
+
+Each of them contains a list of language folders, such as
+/en (English)
+/es (Spanish)
+/fr (French)
+/ja (Japanese)
+/ko (Korean)
+/pt (Portugal)
+/ru (Russian)
+/tr (Turkey)
+/zh-CN (Simplified Chinese)
+
+Each folder contains either a list of JSON files ending .json, or text files ending .txt
+
+# Work with Github
+
+The "main" branch cannot be written directly. You must create a separate branch, make the changes there, commit and push the branch, and then create a PR (Push request) to "main"
+
+For your branch, recommend to use "/changes/{language-code}-{date}" as the branch name.
+
+For example, if you are working on Spanish, and started the work on July 13th, 2022, use the branch name "/changes/es-2022-07-13".
+
+Once your PR is accepted and merged into "main", the branch is removed from the repo. Create a new branch for next batch of changes.
+
+# JSON Translations
+
+Please translate each JSON entry, using the file in /en folder as the original, and translate into the same file name in other language files.
+
+For example, there is a /config/localization/en/app.json file. It should be translated into Spanish in /config/localization/es/app.json file.
+
+The key should stay the same. The value should be translated. For example
+"YOUR_POSITION_WAS_LIQUIDATED": "Your position was liquidated." is translated to Spanish as
+"YOUR_POSITION_WAS_LIQUIDATED": "Tu posición ha sido liquidada."
+
+You will see curly brackets in some cases. Keep the text in the curly brackets as is. For example
+"LEAGUES_LAUNCH_BODY": "Climb the rankings ladder to earn your share of the {PRIZE}." is translated to Spanish as
+"LEAGUES_LAUNCH_BODY": "Asciende en la clasificación para ganar tu parte del {PRIZE}.",
+
+"{PRIZE}" should not be translated.
+
+Make sure the JSON format is still valid. Recommend to use https://jsonformatter.curiousconcept.com to validate the translated JSON
+
+# TXT Translations
+
+Text files can be translated as a single unit.
+
+# Generating app.ts
+'''
+./codegen_localization_app.swift ../config/localization/en/app.json > ./generated/app.ts
+'''
+
+# Generating tooltips.ts
+'''
+./codegen_localization_tooltips.swift ../config/localization/en/tooltips.json > ./generated/tooltips.ts
+'''

package/scripts/codegen_localization_app.swift

@@ -0,0 +1,59 @@
+#!/usr/bin/env swift
+
+import Foundation
+
+// This script is used to generate the TS constants for the app.json file
+
+if CommandLine.arguments.count < 2 {
+    print("Usage: codegen_localization_app.swift <path to app.json>")
+    exit(1)
+}
+
+let appJsonPath = CommandLine.arguments[1]
+var keys: Set<String> = []
+
+guard let appJsonData = FileManager.default.contents(atPath: appJsonPath) else {
+    print("Could not read app.json file at path \(appJsonPath)")
+    exit(1)
+}
+
+guard let appJson = try? JSONSerialization.jsonObject(with: appJsonData, options: []) as? [String: Any] else {
+    print("Could not parse app.json file at path \(appJsonPath)")
+    exit(1)
+}
+
+print("// !! GENERATED FILE - DO NOT EDIT\n")
+print("// Generated from \(appJsonPath) using \(CommandLine.arguments[0])\n")
+
+for key in appJson.keys.sorted() {
+    print("export const \(key)_STRING_KEYS = {")
+    generateItems(keyPath: key, lastKey: nil, value: appJson[key])
+    print("};\n") 
+}
+
+func generateItems(keyPath: String, lastKey: String?, value: Any?) {
+    let digits = CharacterSet.decimalDigits
+
+    if let value = value as? [String: Any] {
+        if let lastKey = lastKey {
+            print("\n    // \(lastKey)\n")
+        }
+        for subKey in value.keys.sorted() {
+            generateItems(keyPath: keyPath + "." + subKey, lastKey: subKey, value: value[subKey])
+        }
+    } else if let lastKey = lastKey {
+        // ensure no duplicate keys
+        if (keys.contains(lastKey)) {
+            return
+        }
+        
+        keys.insert(lastKey)
+
+        // add single quotes to keys that start with a number
+        if let range = lastKey.rangeOfCharacter(from: digits), range.lowerBound == lastKey.startIndex {
+            print("    \'\(lastKey)\': \'\(keyPath)\',")
+        } else {
+            print("    \(lastKey): \'\(keyPath)\',")
+        }
+    }
+}

package/scripts/codegen_localization_tooltips.swift

@@ -0,0 +1,46 @@
+#!/usr/bin/env swift
+
+import Foundation
+
+// This script is used to generate the TS constants for the tooltips.json file
+
+if CommandLine.arguments.count < 2 {
+    print("Usage: codegen_localization_app.swift <path to tooltips.json>")
+    exit(1)
+}
+
+let appJsonPath = CommandLine.arguments[1]
+
+guard let appJsonData = FileManager.default.contents(atPath: appJsonPath) else {
+    print("Could not read tooltips.json file at path \(appJsonPath)")
+    exit(1)
+}
+
+guard let appJson = try? JSONSerialization.jsonObject(with: appJsonData, options: []) as? [String: Any] else {
+    print("Could not parse tooltips.json file at path \(appJsonPath)")
+    exit(1)
+}
+
+print("// !! GENERATED FILE - DO NOT EDIT\n")
+print("// Generated from \(appJsonPath) using \(CommandLine.arguments[1])\n")
+
+print("export const TOOLTIP_STRING_KEYS = {")
+generateItems(keyPath: "TOOLTIPS", lastKey: nil, value: appJson)
+print("};\n") 
+
+
+func generateItems(keyPath: String, lastKey: String?, value: Any?) {
+    if let value = value as? [String: Any] {
+        if let lastKey = lastKey,  value.keys.contains("TITLE"),  value.keys.contains("BODY") {
+            print("    \(lastKey)_BODY: \'\(keyPath).BODY\',")
+            print("    \(lastKey)_TITLE: \'\(keyPath).TITLE\',")
+        } else {
+            if let lastKey = lastKey {
+                print("\n    // \(lastKey)\n")
+            }
+            for subKey in value.keys.sorted() {
+                generateItems(keyPath: keyPath + "." + subKey, lastKey: subKey, value: value[subKey])
+            }
+        }
+    } 
+}