Translation tempaltes: Allow specifying comments

personalizedrefrigerator · Sep 21, 2023 · 2dbea52 · 2dbea52
1 parent aeab495
commit 2dbea52
Show file tree

Hide file tree

Showing 6 changed files with 190 additions and 9 deletions.
diff --git a/.github/ISSUE_TEMPLATE/translation-js-draw-de.yml b/.github/ISSUE_TEMPLATE/translation-js-draw-de.yml
@@ -109,7 +109,10 @@ body:
       label: "dragAndDropHereOrBrowse"
       description: "Translate `Drag and drop here
 or
-{{browse}}`."
+{{browse}}`.
+
+> **Note**:
+> Uses {{curly braces}} to denote bold text"
       placeholder: "Drag and drop here
 or
 {{browse}}"
@@ -205,6 +208,22 @@ or
       value: "Auswahl duplizieren"
     validations:
       required: false
+  - type: input
+    id: translation-exit
+    attributes:
+      label: "exit"
+      description: "Translate `Exit`."
+      placeholder: "Exit"
+    validations:
+      required: false
+  - type: input
+    id: translation-save
+    attributes:
+      label: "save"
+      description: "Translate `Save`."
+      placeholder: "Save"
+    validations:
+      required: false
   - type: input
     id: translation-undo
     attributes:
@@ -320,6 +339,14 @@ or
       value: "Gitter: "
     validations:
       required: false
+  - type: input
+    id: translation-enableAutoresizeOption
+    attributes:
+      label: "enableAutoresizeOption"
+      description: "Translate `Auto-resize`."
+      placeholder: "Auto-resize"
+    validations:
+      required: false
   - type: input
     id: translation-toggleOverflow
     attributes:
@@ -438,7 +465,10 @@ or
     id: translation-closeSidebar
     attributes:
       label: "closeSidebar"
-      description: "Translate ``(toolName) => `Close sidebar for ${toolName}` ``."
+      description: "Translate ``(toolName) => `Close sidebar for ${toolName}` ``.
+
+> **Note**:
+> Currently used as an accessibilty label"
       placeholder: "(toolName) => `Close sidebar for ${toolName}`"
       value: "(toolName) => `Close sidebar for ${toolName}`"
     validations:
@@ -792,6 +822,22 @@ or
       value: "(newSize) => `Bildgröße auf ${newSize.w}x${newSize.h} geändert`"
     validations:
       required: false
+  - type: input
+    id: translation-enabledAutoresizeOutputCommand
+    attributes:
+      label: "enabledAutoresizeOutputCommand"
+      description: "Translate `Enabled output autoresize`."
+      placeholder: "Enabled output autoresize"
+    validations:
+      required: false
+  - type: input
+    id: translation-disabledAutoresizeOutputCommand
+    attributes:
+      label: "disabledAutoresizeOutputCommand"
+      description: "Translate `Disabled output autoresize`."
+      placeholder: "Disabled output autoresize"
+    validations:
+      required: false
   - type: input
     id: translation-addElementAction
     attributes:

diff --git a/.github/ISSUE_TEMPLATE/translation-js-draw-es.yml b/.github/ISSUE_TEMPLATE/translation-js-draw-es.yml
@@ -105,7 +105,10 @@ body:
       label: "dragAndDropHereOrBrowse"
       description: "Translate `Drag and drop here
 or
-{{browse}}`."
+{{browse}}`.
+
+> **Note**:
+> Uses {{curly braces}} to denote bold text"
       placeholder: "Drag and drop here
 or
 {{browse}}"
@@ -198,6 +201,22 @@ or
       value: "Duplica la selección"
     validations:
       required: false
+  - type: input
+    id: translation-exit
+    attributes:
+      label: "exit"
+      description: "Translate `Exit`."
+      placeholder: "Exit"
+    validations:
+      required: false
+  - type: input
+    id: translation-save
+    attributes:
+      label: "save"
+      description: "Translate `Save`."
+      placeholder: "Save"
+    validations:
+      required: false
   - type: input
     id: translation-undo
     attributes:
@@ -311,6 +330,14 @@ or
       placeholder: "Grid"
     validations:
       required: false
+  - type: input
+    id: translation-enableAutoresizeOption
+    attributes:
+      label: "enableAutoresizeOption"
+      description: "Translate `Auto-resize`."
+      placeholder: "Auto-resize"
+    validations:
+      required: false
   - type: input
     id: translation-toggleOverflow
     attributes:
@@ -427,7 +454,10 @@ or
     id: translation-closeSidebar
     attributes:
       label: "closeSidebar"
-      description: "Translate ``(toolName) => `Close sidebar for ${toolName}` ``."
+      description: "Translate ``(toolName) => `Close sidebar for ${toolName}` ``.
+
+> **Note**:
+> Currently used as an accessibilty label"
       placeholder: "(toolName) => `Close sidebar for ${toolName}`"
       value: "(toolName) => `Close sidebar for ${toolName}`"
     validations:
@@ -773,6 +803,22 @@ or
       value: "(newSize) => `Resized image to ${newSize.w}x${newSize.h}`"
     validations:
       required: false
+  - type: input
+    id: translation-enabledAutoresizeOutputCommand
+    attributes:
+      label: "enabledAutoresizeOutputCommand"
+      description: "Translate `Enabled output autoresize`."
+      placeholder: "Enabled output autoresize"
+    validations:
+      required: false
+  - type: input
+    id: translation-disabledAutoresizeOutputCommand
+    attributes:
+      label: "disabledAutoresizeOutputCommand"
+      description: "Translate `Disabled output autoresize`."
+      placeholder: "Disabled output autoresize"
+    validations:
+      required: false
   - type: input
     id: translation-addElementAction
     attributes:

diff --git a/.github/ISSUE_TEMPLATE/translation-js-draw-new.yml b/.github/ISSUE_TEMPLATE/translation-js-draw-new.yml
@@ -99,7 +99,10 @@ body:
       label: "dragAndDropHereOrBrowse"
       description: "Translate `Drag and drop here
 or
-{{browse}}`."
+{{browse}}`.
+
+> **Note**:
+> Uses {{curly braces}} to denote bold text"
       placeholder: "Drag and drop here
 or
 {{browse}}"
@@ -185,6 +188,22 @@ or
       placeholder: "Duplicate selection"
     validations:
       required: false
+  - type: input
+    id: translation-exit
+    attributes:
+      label: "exit"
+      description: "Translate `Exit`."
+      placeholder: "Exit"
+    validations:
+      required: false
+  - type: input
+    id: translation-save
+    attributes:
+      label: "save"
+      description: "Translate `Save`."
+      placeholder: "Save"
+    validations:
+      required: false
   - type: input
     id: translation-undo
     attributes:
@@ -289,6 +308,14 @@ or
       placeholder: "Grid"
     validations:
       required: false
+  - type: input
+    id: translation-enableAutoresizeOption
+    attributes:
+      label: "enableAutoresizeOption"
+      description: "Translate `Auto-resize`."
+      placeholder: "Auto-resize"
+    validations:
+      required: false
   - type: input
     id: translation-toggleOverflow
     attributes:
@@ -397,7 +424,10 @@ or
     id: translation-closeSidebar
     attributes:
       label: "closeSidebar"
-      description: "Translate ``(toolName) => `Close sidebar for ${toolName}` ``."
+      description: "Translate ``(toolName) => `Close sidebar for ${toolName}` ``.
+
+> **Note**:
+> Currently used as an accessibilty label"
       placeholder: "(toolName) => `Close sidebar for ${toolName}`"
     validations:
       required: false
@@ -713,6 +743,22 @@ or
       placeholder: "(newSize) => `Resized image to ${newSize.w}x${newSize.h}`"
     validations:
       required: false
+  - type: input
+    id: translation-enabledAutoresizeOutputCommand
+    attributes:
+      label: "enabledAutoresizeOutputCommand"
+      description: "Translate `Enabled output autoresize`."
+      placeholder: "Enabled output autoresize"
+    validations:
+      required: false
+  - type: input
+    id: translation-disabledAutoresizeOutputCommand
+    attributes:
+      label: "disabledAutoresizeOutputCommand"
+      description: "Translate `Disabled output autoresize`."
+      placeholder: "Disabled output autoresize"
+    validations:
+      required: false
   - type: input
     id: translation-addElementAction
     attributes:

diff --git a/packages/build-tool/src/buildTranslationTemplates.ts b/packages/build-tool/src/buildTranslationTemplates.ts
@@ -43,12 +43,17 @@ const generateTranslationTemplate = (
 	// Strings in the default locale (which has all strings translated)
 	defaultLocaleStrings: any,
 
+	// A map from translation keys to comments
+	translationComments?: Record<string, string|string[]>,
+
 	// The locale the user will be translating into
 	destLocale?: string,
 
 	// Strings in destLocale
 	destLocaleStrings?: any,
 ) => {
+	translationComments ??= {};
+
 	const bodyContentLines: string[] = [];
 
 	const addInput = (
@@ -110,9 +115,20 @@ const generateTranslationTemplate = (
 			currentTranslation = undefined;
 		}
 
+		let comments: string|string[] = translationComments[key] ?? [];
+		if (typeof comments === 'string') {
+			comments = [ comments ];
+		}
+		comments = comments.map(comment => `> **Note**:\n> ${comment.replace(/\n/g, '\n> ')}`);
+
+		const description = [
+			`Translate ${codeFormat(englishTranslation)}.`,
+			...comments,
+		].join('\n\n');
+
 		addInput('input', `translation-${key}`, {
 			label: `${key}`,
-			description: `Translate ${codeFormat(englishTranslation)}.`,
+			description,
 			placeholder: englishTranslation,
 			value: currentTranslation,
 		});
@@ -142,7 +158,11 @@ ${bodyContentLines.join('\n')}`;
 const buildTranslationTemplate = async (source: TranslationSource, destFolder: string) => {
 	const projName = source.name;
 
-	const locales = (await import(source.path)).default;
+	// eslint-disable-next-line @typescript-eslint/no-var-requires
+	const translationData = require(source.path);
+
+	const locales = translationData.default ?? translationData.locales;
+	const comments = translationData.comments;
 
 	// Write the translation template for the current source.
 	// locale should be the destination locale or undefined if there is no specific
@@ -152,6 +172,9 @@ const buildTranslationTemplate = async (source: TranslationSource, destFolder: s
 			projName,
 			locales[source.defaultLocale],
 
+			// Comments on the translation keys
+			comments,
+
 			// Destination locale
 			locale,
 

diff --git a/packages/js-draw/src/localizations/comments.ts b/packages/js-draw/src/localizations/comments.ts
@@ -0,0 +1,12 @@
+
+import { EditorLocalization } from '../localization';
+
+/**
+ * Comments to help translators create translations.
+ */
+const comments: Partial<Record<keyof EditorLocalization, string>> = {
+	dragAndDropHereOrBrowse: 'Uses {{curly braces}} to denote bold text',
+	closeSidebar: 'Currently used as an accessibilty label',
+};
+
+export default comments;
diff --git a/packages/js-draw/tools/allLocales.js b/packages/js-draw/tools/allLocales.js
@@ -1,4 +1,12 @@
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const allLocales = require('../dist/cjs/localizations/getLocalizationTable').allLocales;
-module.exports = allLocales;
+
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const comments = require('../dist/cjs/localizations/comments').default;
+
+
+module.exports = {
+	locales: allLocales,
+	comments,
+};