Merge pull request #13 from matrix-org/t3chguy/localazy-custom-transl…

…ations

.gitignore

@@ -9,4 +9,5 @@ lib-cov
 out
 /dist
 /lib
+/src/*.js
 /scripts/*.js

scripts/common.ts

@@ -16,9 +16,9 @@ limitations under the License.
 
 import fs from "fs";
 import { isBinaryExpression, isStringLiteral, isTemplateLiteral, Node } from "@babel/types";
-import { Translation, Translations } from "../src";
+import { KEY_SEPARATOR, Translation, Translations } from "../src";
 
-export const NESTING_KEY = process.env["NESTING_KEY"] || "|";
+export const NESTING_KEY = process.env["NESTING_KEY"] || KEY_SEPARATOR;
 export const INPUT_FILE = process.env["INPUT_FILE"] || 'src/i18n/strings/en_EN.json';
 export const OUTPUT_FILE = process.env["OUTPUT_FILE"] || 'src/i18n/strings/en_EN.json';
 

scripts/rekey.ts

@@ -37,6 +37,9 @@ const translation = _.get(sourceTranslations, oldPath);
 if (!translation) {
     throw new Error(`"${argv._[0]}" key not present in source translations`);
 }
+if (_.get(sourceTranslations, newPath)) {
+    throw new Error(`"${argv._[1]}" key already present in source translations`);
+}
 
 function updateTranslations(translations: Translations): void {
     const value = _.get(translations, oldPath);

src/index.ts

@@ -14,5 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+export const KEY_SEPARATOR = "|";
+
 export * from "./utils";
 export * from "./types";

src/types.ts

@@ -14,6 +14,8 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+import { KEY_SEPARATOR } from "./index";
+
 /**
  * Utility type for string dot notation for accessing nested object properties.
  * Based on https://stackoverflow.com/a/58436959
@@ -57,7 +59,7 @@ type Join<K, P, S extends string = "."> = K extends string | number
  * @typeParam MaxDepth the maximum depth to recurse to
  * @returns a union type representing all dot (Separator) string notation keys which can access a Leaf (of LeafType)
  */
-export type TranslationKey<T extends Translations> = Leaves<T, "|", string | { other: string }>;
+export type TranslationKey<T extends Translations> = Leaves<T, typeof KEY_SEPARATOR, string | { other: string }, 4>;
 
 export type Translation = string | {
     one?: string;