starting some translations

RafaelGB · RafaelGB · commit 37fd58608635 · 2022-12-22T18:38:41.000+01:00
diff --git a/src/components/modals/addRow/handlers/FilenameTextHandler.ts b/src/components/modals/addRow/handlers/FilenameTextHandler.ts
@@ -1,9 +1,10 @@
 import { AddRowModalHandlerResponse } from "cdm/ModalsModel";
+import { t } from "lang/helpers";
 import { Setting } from "obsidian";
 import { AbstractHandlerClass } from "patterns/chain/AbstractHandler";
 
 export class FilenameTextHandler extends AbstractHandlerClass<AddRowModalHandlerResponse> {
-    settingTitle: string = "Filename";
+    settingTitle: string = t("add_row_modal_filename_text_title");
     textElId: string = "AddRowModalManager-addRow-input";
     handle(
         response: AddRowModalHandlerResponse
@@ -29,7 +30,7 @@ export class FilenameTextHandler extends AbstractHandlerClass<AddRowModalHandler
          **************/
         new Setting(containerEl)
             .setName(this.settingTitle)
-            .setDesc("Filename associated with the new row")
+            .setDesc(t("add_row_modal_filename_text_desc"))
             .addText(text => {
                 text.inputEl.setAttribute("id", this.textElId);
                 text.inputEl.onkeydown = (e: KeyboardEvent) => {
@@ -39,7 +40,7 @@ export class FilenameTextHandler extends AbstractHandlerClass<AddRowModalHandler
                             break;
                     }
                 };
-                text.setPlaceholder("Enter filename")
+                text.setPlaceholder(t("add_row_modal_filename_text_placeholder"))
                     .setValue(newFilename)
                     .onChange(async (value: string): Promise<void> => {
                         newFilename = value;
@@ -48,7 +49,7 @@ export class FilenameTextHandler extends AbstractHandlerClass<AddRowModalHandler
             .addButton((button) => {
                 button
                     .setIcon("create-new")
-                    .setTooltip("Add new row")
+                    .setTooltip(t("add_row_modal_filename_text_button_tooltip"))
                     .onClick(addNewRowPromise);
             });
         return this.goNext(response);
diff --git a/src/components/modals/addRow/handlers/TemplateDropdownHandler.ts b/src/components/modals/addRow/handlers/TemplateDropdownHandler.ts
@@ -1,10 +1,11 @@
 import { AddRowModalHandlerResponse } from "cdm/ModalsModel";
+import { t } from "lang/helpers";
 import { Setting } from "obsidian";
 import { AbstractHandlerClass } from "patterns/chain/AbstractHandler";
 import { StringSuggest } from "settings/suggesters/StringSuggester";
 
 export class TemplateDropdownHandler extends AbstractHandlerClass<AddRowModalHandlerResponse> {
-    settingTitle: string = "Row Template";
+    settingTitle: string = t("add_row_modal_template_dropdown_title");
     handle(
         response: AddRowModalHandlerResponse
     ): AddRowModalHandlerResponse {
@@ -25,13 +26,13 @@ export class TemplateDropdownHandler extends AbstractHandlerClass<AddRowModalHan
 
         new Setting(containerEl)
             .setName(this.settingTitle)
-            .setDesc('Select from the existing templates to create a new row. The list is related with template folder setting. Leave empty to create an empty file.')
+            .setDesc(t('add_row_modal_template_dropdown_desc'))
             .addSearch((cb) => {
                 new StringSuggest(
                     cb.inputEl,
                     avaliableOptions
                 );
-                cb.setPlaceholder("Select a template...")
+                cb.setPlaceholder(t("add_row_modal_template_dropdown_placeholder"))
                     .setValue(rowTemplate.template)
                     .onChange(updateTemplatHandler);
 
diff --git a/src/components/modals/newColumn/addColumnModal.ts b/src/components/modals/newColumn/addColumnModal.ts
@@ -6,6 +6,7 @@ import { add_setting_header } from "settings/SettingsComponents";
 import { select_new_column_section } from "components/modals/newColumn/SelectNewColumnSection";
 import { c } from "helpers/StylesHelper";
 import { applyPluginModalStyle } from "components/styles/ModalStyles";
+import { t } from "lang/helpers";
 
 export class AddColumnModal extends Modal {
     view: DatabaseView;
@@ -49,7 +50,7 @@ export class AddColumnModalManager {
         /** Common modal headings */
         containerEl.addClass(c(StyleClasses.ADD_COLUMN_MODAL));
         applyPluginModalStyle(containerEl);
-        add_setting_header(containerEl, `Columns menu`, 'h2');
+        add_setting_header(containerEl, t("add_row_modal_section_title"), 'h2');
 
         const addColumnBody = containerEl.createDiv();
         addColumnBody.setAttribute("id", StyleClasses.ADD_COLUMN_MODAL_BODY);
diff --git a/src/components/modals/newColumn/handlers/AddEmptyColumnHandler.ts b/src/components/modals/newColumn/handlers/AddEmptyColumnHandler.ts
@@ -5,7 +5,7 @@ import { Notice, Setting } from "obsidian";
 import { AbstractHandlerClass } from "patterns/chain/AbstractHandler";
 
 export class AddEmptyColumnHandler extends AbstractHandlerClass<AddColumnModalHandlerResponse> {
-  settingTitle: string = "Add empty column";
+  settingTitle: string = t("add_row_modal_add_empty_column_title");
   textElId: string = "SettingsModalManager-addEmptyColumn-input";
   handle(
     response: AddColumnModalHandlerResponse
@@ -25,7 +25,11 @@ export class AddEmptyColumnHandler extends AbstractHandlerClass<AddColumnModalHa
         isEmpty ? undefined : newColumnName,
         typeOfNewColumn ? typeOfNewColumn : DynamicInputType.TEXT
       );
-      new Notice(isEmpty ? "New column added" : `"${newColumnName}" added to the table`, 1500);
+      new Notice(
+        isEmpty ?
+          t("add_row_modal_add_empty_notice_empty") :
+          t("add_row_modal_add_empty_notice_informed", newColumnName),
+        1500);
       (activeDocument.getElementById(this.textElId) as HTMLInputElement).value = "";
     }
 
@@ -38,7 +42,7 @@ export class AddEmptyColumnHandler extends AbstractHandlerClass<AddColumnModalHa
      **************/
     new Setting(containerEl)
       .setName(this.settingTitle)
-      .setDesc("Add a new column which do not exist yet in any row")
+      .setDesc(t("add_row_modal_add_empty_column_desc"))
       .addText(text => {
         text.inputEl.setAttribute("id", this.textElId);
         text.inputEl.onkeydown = (e: KeyboardEvent) => {
@@ -48,7 +52,7 @@ export class AddEmptyColumnHandler extends AbstractHandlerClass<AddColumnModalHa
               break;
           }
         };
-        text.setPlaceholder("Column name")
+        text.setPlaceholder(t("add_row_modal_add_empty_column_placeholder"))
           .setValue(newColumnName)
           .onChange(async (value: string): Promise<void> => {
             newColumnName = value;
@@ -62,7 +66,7 @@ export class AddEmptyColumnHandler extends AbstractHandlerClass<AddColumnModalHa
       .addExtraButton((button) => {
         button
           .setIcon("create-new")
-          .setTooltip("Add new column")
+          .setTooltip(t("add_row_modal_add_empty_column_button_tooltip"))
           .onClick(addNewColumnPromise);
       });
     return this.goNext(response);
diff --git a/src/components/modals/newColumn/handlers/AddExistingColumnHandler.ts b/src/components/modals/newColumn/handlers/AddExistingColumnHandler.ts
@@ -8,7 +8,7 @@ import { AbstractHandlerClass } from "patterns/chain/AbstractHandler";
 import { StringSuggest } from "settings/suggesters/StringSuggester";
 
 export class AddExistingColumnHandler extends AbstractHandlerClass<AddColumnModalHandlerResponse> {
-    settingTitle: string = 'Add existing column';
+    settingTitle: string = t("add_row_modal_add_existing_column_title");
     handle(response: AddColumnModalHandlerResponse): AddColumnModalHandlerResponse {
         const { containerEl, addColumnModalManager } = response;
         const { configState, columnState } = addColumnModalManager.props;
@@ -44,14 +44,14 @@ export class AddExistingColumnHandler extends AbstractHandlerClass<AddColumnModa
                     filteredColumns[columnName] = columnName;
                 });
             new Setting(containerEl)
-                .setName('Select an existing column to add')
-                .setDesc('Select an existing column to add not included yet in the table')
+                .setName(this.settingTitle)
+                .setDesc(t("add_row_modal_add_existing_column_desc"))
                 .addSearch((cb) => {
                     new StringSuggest(
                         cb.inputEl,
                         filteredColumns
                     );
-                    cb.setPlaceholder("Search column...")
+                    cb.setPlaceholder(t("add_row_modal_add_existing_column_placeholder"))
                         .setValue(selectedColumn)
                         .onChange((value: string) => {
                             selectedColumn = value;
@@ -65,10 +65,10 @@ export class AddExistingColumnHandler extends AbstractHandlerClass<AddColumnModa
                 })
                 .addExtraButton((cb) => {
                     cb.setIcon("create-new")
-                        .setTooltip("Create the selected column and refresh the table")
+                        .setTooltip(t("add_row_modal_add_existing_column_button_tooltip"))
                         .onClick(async (): Promise<void> => {
                             if (!selectedColumn || filteredColumns[selectedColumn] === undefined) {
-                                new Notice("You need to select a column to add", 1500);
+                                new Notice(t("add_row_modal_add_existing_notice_error_empty"), 1500);
                                 return;
                             }
                             columnState.actions.addToLeft(
@@ -79,7 +79,7 @@ export class AddExistingColumnHandler extends AbstractHandlerClass<AddColumnModa
                             addColumnModalManager.addColumnModal.enableReset = true;
                             // Refresh the modal to remove the selected column from the dropdown
                             addColumnModalManager.reset(response);
-                            new Notice(`"${selectedColumn}" added to the table`, 1500);
+                            new Notice(t("add_row_modal_add_existing_notice_correct", selectedColumn), 1500);
 
                         });
                 });
diff --git a/src/lang/helpers.ts b/src/lang/helpers.ts
@@ -54,10 +54,25 @@ const localeMap: { [k: string]: Partial<typeof en> } = {
 const lang = localStorage.getItem('language');
 const locale = localeMap[lang || 'en'];
 
-export function t(str: keyof typeof en): string {
+/**
+ * Translate a string to the current language or English if not found.
+ * 
+ * You can pass in arguments to replace in the string using {0}, {1}, etc.
+ * @param str 
+ * @param args 
+ * @returns 
+ */
+export function t(str: keyof typeof en, ...args: string[]): string {
   if (!locale) {
     LOGGER.error('Error: database locale not found', lang);
   }
+  const translated = (locale && locale[str]) || en[str];
 
-  return (locale && locale[str]) || en[str] || str;
+  if (!translated) {
+    LOGGER.warn('String key not found in locale', str);
+    return str;
+  }
+
+  // Replace any arguments in the string
+  return args.reduce((acc, arg, i) => acc.replace(`{${i}}`, arg), translated);
 }
diff --git a/src/lang/locale/en.ts b/src/lang/locale/en.ts
@@ -66,11 +66,36 @@ export default {
   "inlinks": "Inlinks",
   "outlinks": "Outlinks",
   "new_column": "New column",
-  /** MODALS */
-  "confirm_modal_ok": "Yes",
-  "confirm_modal_ko": "No",
   /** NEW INLINE PROPERTIES POSITION */
   "top": "Top",
   "bottom": "Bottom",
   "last_field": "Last field",
+  /****************************************** 
+   *              MODALS
+   ******************************************/
+  /** CONFIRM MODAL */
+  "confirm_modal_ok": "Yes",
+  "confirm_modal_ko": "No",
+  /** ADD ROW MODAL */
+  "add_row_modal_filename_text_title": "Filename",
+  "add_row_modal_filename_text_desc": "Filename associated with the new row",
+  "add_row_modal_filename_text_placeholder": "Enter filename",
+  "add_row_modal_filename_text_button_tooltip": "Add new row",
+  "add_row_modal_template_dropdown_title": "Row Template",
+  "add_row_modal_template_dropdown_desc": "Select from the existing templates to create a new row. The list is related with template folder setting. Leave empty to create an empty file.",
+  "add_row_modal_template_dropdown_placeholder": "Select a template...",
+  /** ADD COLUMN MODAL */
+  "add_row_modal_section_title": "Columns menu",
+  "add_row_modal_add_empty_column_title": "Add empty column",
+  "add_row_modal_add_empty_column_desc": "Add a new column which do not exist yet in any row",
+  "add_row_modal_add_empty_column_placeholder": "Column name",
+  "add_row_modal_add_empty_column_button_tooltip": "Add new column",
+  "add_row_modal_add_empty_notice_empty": "New column added",
+  "add_row_modal_add_empty_notice_informed": "{0} added to the table",
+  "add_row_modal_add_existing_column_title": "Select an existing column to add",
+  "add_row_modal_add_existing_column_desc": "Select an existing column to add not included yet in the table",
+  "add_row_modal_add_existing_column_placeholder": "Search column...",
+  "add_row_modal_add_existing_column_button_tooltip": "Create the selected column and refresh the table",
+  "add_row_modal_add_existing_notice_error_empty": "You need to select a column to add",
+  "add_row_modal_add_existing_notice_correct": "{0} added to the table",
 };
