⚡ i18n feedback refactorings (#2597)

* ⚡ Create endpoint for node credential translation * ⚡ Add API helper method in FE * 🔨 Add creds JSON files to tsconfig * ⚡ Refactor credentials loading * ⚡ Refactor calls in CredentialConfig * ✏️ Add dummy translations * ⚡ Split translations per node * 🔥 Remove deprecated method * ⚡ Refactor nesting in collections * 🚚 Rename topParameter methods for accuracy * ✏️ Fill out GitHub dummy cred * 🚚 Clarify naming for collection utils * ✏️ Fill out dummy translation * 🔥 Remove surplus colons * 🔥 Remove logging * ⚡ Restore missing space * 🔥 Remove lingering colon * ⚡ Add path to InputLabel calls * ✏️ Fill out dummy translations * 🐛 Fix multipleValuesButtonText logic * ⚡ Add sample properties to be deleted * ⚡ Render deeply nested params * 📦 Update package-lock.json * 🔥 remove logging * ✏️ Add dummy value to Slack translation * ✏️ Add placeholder to dummy translation * ⚡ Fix placeholder rendering for button text * 👕 Fix lint * 🔥 Remove outdated comment * 🐛 Pass in missing arg for placeholder * ✏️ Fill out Slack translation * ⚡ Add explanatory comment * ✏️ Fill out dummy translation * ✏️ Update documentation * 🔥 Remove broken link * ✏️ Add pending functionality * ✏️ Fix indentation * 🐛 Fix method call in CredentialEdit * ⚡ Implement eventTriggerDescription * 🐛 Fix table-json-binary radio buttons * ✏️ Clarify usage of eventTriggerDescription * 🔥 Remove unneeded arg * 🐛 Fix display in CodeEdit and TextEdit * 🔥 Remove logging * ✏️ Add translation for test cred options * ✏️ Add test for separate file in same dir * ✏️ Add test for versioned node * ✏️ Add test for node in grouped dir * ✏️ Add minor clarifications * ✏️ Add nested collection test * ✏️ Add pending functionality * ⚡ Generalize collections handling * 🚚 Rename helper to remove redundancy * 🚚 Improve naming in helpers * ✏️ Improve helpers documentation * ✏️ Improve i18n methods documentation * 🚚 Make endpoint naming consistent * ✏️ Add final newlines * ✏️ Clean up JSON examples * ⚡ Reuse i18n method * ⚡ Improve utils readability * ⚡ Return early if cred translation exists * 🔥 Remove dummy translations
2022-01-07 22:02:21 +01:00
parent 6a2db6d107
commit 5fec563c5c
30 changed files with 920 additions and 634 deletions
--- a/packages/editor-ui/src/plugins/i18n/docs/ADDENDUM.md
+++ b/packages/editor-ui/src/plugins/i18n/docs/ADDENDUM.md
@@ -0,0 +1,114 @@
+# Addendum for i18n in n8n
+
+## Base text
+
+### Interpolation
+
+Certain base text strings use [interpolation](https://kazupon.github.io/vue-i18n/guide/formatting.html#named-formatting) to allow for a variable to be passed in, signalled by curly braces:
+
+```json
+{
+	"stopExecution": {
+		"message": "The execution with the ID {activeExecutionId} got stopped!",
+		"title": "Execution stopped"
+	}
+}
+```
+
+When translating a string containing an interpolated variable, leave the variable untranslated:
+
+```json
+{
+	"stopExecution": {
+		"message": "Die Ausführung mit der ID {activeExecutionId} wurde gestoppt",
+		"title": "Execution stopped"
+	}
+}
+```
+
+### Reusable base text
+
+As a convenience, the base text file may contain the special key `reusableBaseText`, which defines strings that can be shared among other strings with the syntax `@:reusableBaseText.key`, as follows:
+
+```json
+{
+	"reusableBaseText": {
+		"save": "🇩🇪 Save",
+	},
+	"duplicateWorkflowDialog": {
+		"enterWorkflowName": "🇩🇪 Enter workflow name",
+		"save": "@:reusableBaseText.save",
+	},
+	"saveButton": {
+		"save": "@:reusableBaseText.save",
+		"saving": "🇩🇪 Saving",
+		"saved": "🇩🇪 Saved",
+	},
+}
+```
+
+For more information, refer to Vue i18n's [linked locale messages](https://kazupon.github.io/vue-i18n/guide/messages.html#linked-locale-messages).
+
+### Nodes in versioned dirs
+
+For nodes in versioned dirs, place the `/translations` dir for the node translation file alongside the versioned `*.node.ts` file:
+
+```
+Mattermost
+  └── Mattermost.node.ts
+    └── v1
+        ├── MattermostV1.node.ts
+        ├── actions
+        ├── methods
+        ├── transport
+        └── translations
+            └── de
+                └── mattermost.json
+```
+
+### Nodes in grouping dirs
+
+For nodes in grouping dirs, e.g. Google nodes, place the `/translations` dir for the node translation file alongside the `*.node.ts` file:
+
+```
+Google
+  ├── Books
+  ├── Calendar
+  └── Drive
+      ├── GoogleDrive.node.ts
+      └── translations
+          └── de
+              ├── googleDrive.json
+              └── googleDriveTrigger.json
+```
+
+## Dynamic text
+
+### Reusable dynamic text
+
+The base text file may contain the special key `reusableDynamicText`, allowing for a node parameter to be translated once and reused in all other node parameter translations.
+
+Currently only the keys `oauth.clientId` and `oauth.clientSecret` are supported as a PoC - these two translations will be reused in all node credential parameters.
+
+```json
+{
+	"reusableDynamicText": {
+		"oauth2": {
+			"clientId": "🇩🇪 Client ID",
+			"clientSecret": "🇩🇪 Client Secret",
+		}
+	}
+}
+```
+
+### Special cases
+
+`eventTriggerDescription` is a dynamic node property that is not part of node parameters. To translate it, set the `eventTriggerDescription` key at the root level of the `nodeView` property in the node translation file.
+
+```json
+{
+	"nodeView": {
+		"eventTriggerDescription": "🇩🇪 Waiting for you to call the Test URL"
+	}
+}
+```