Migrating to v2 go-i18n message format

Author: allmightyspiff

bin/buildAndDeploy.py

@@ -16,16 +16,16 @@
 
 
 i18n_files = [
-'en_US.all.json',
-'de_DE.all.json',
-'es_ES.all.json',
-'fr_FR.all.json',
-'it_IT.all.json',
-'ja_JP.all.json',
-'ko_KR.all.json',
-'pt_BR.all.json',
-'zh_Hans.all.json',
-'zh_Hant.all.json',
+'en_US.json',
+'de_DE.json',
+'es_ES.json',
+'fr_FR.json',
+'it_IT.json',
+'ja_JP.json',
+'ko_KR.json',
+'pt_BR.json',
+'zh_Hans.json',
+'zh_Hant.json',
 ]
 
 def isWindows() -> bool:

bin/i18nUpdater.py

@@ -0,0 +1,60 @@
+#!python
+
+import os
+import click
+import json
+
+
+i18n_files = [
+'en_US',
+'de_DE',
+'es_ES',
+'fr_FR',
+'it_IT',
+'ja_JP',
+'ko_KR',
+'pt_BR',
+'zh_Hans',
+'zh_Hant',
+]
+
+
+
+
+def reformat(filename: str):
+    plugin_dir = os.path.join(os.getcwd(), 'plugin')
+    i18n_path = os.path.join(plugin_dir, 'i18n', 'v1Resources', f"{filename}.json")
+    new_i18n = os.path.join(plugin_dir, 'i18n', 'v2Resources', f"active.{filename}.json")
+    original = get_source_data(i18n_path)
+    reformatted = {}
+    for key in original:
+        translation = original[key].get('translation', '')
+        if translation == '':
+            translation = key
+        reformatted[key] = {"other": translation}
+    with open(new_i18n, 'w', encoding="utf8", newline='\n') as f:
+       json.dump(reformatted, f, sort_keys=True, separators=(',', ': ',), ensure_ascii=False, indent=2)
+    f.close()
+
+def get_source_data(file_name: str) -> dict:
+    """Reads from the i18n files and returns a formatted dict"""
+    source_i18n = {}
+    with open(file_name, encoding="utf8") as f:
+        data = json.load(f)
+        for i in data:
+            source_i18n[i.get('id')] = i
+    f.close()
+    return source_i18n
+
+@click.command()
+def cli():
+    cwd = os.getcwd()
+    if not cwd.endswith('softlayer-cli'):
+        raise Exception(f"Working Directory should be softlayer-cli, is currently {self.cwd}")
+    for file in i18n_files:
+    	click.echo(f"Working on {file}")
+    	reformat(file)
+
+
+if __name__ == '__main__':
+    cli()

plugin/commands/account/hook_create.go

@@ -35,8 +35,8 @@ func NewHookCreateCommand(sl *metadata.SoftlayerCommand) *HookCreateCommand {
 		},
 	}
 
-	cobraCmd.Flags().StringVarP(&thisCmd.Name, "name", "N", "", T("The name of the hook."+" "+T("[required]")))
-	cobraCmd.Flags().StringVarP(&thisCmd.Uri, "uri", "U", "", T("The endpoint that the script will be downloaded."+" "+T("[required]")))
+	cobraCmd.Flags().StringVarP(&thisCmd.Name, "name", "N", "", T("The name of the hook.") + " " +T("[required]"))
+	cobraCmd.Flags().StringVarP(&thisCmd.Uri, "uri", "U", "", T("The endpoint that the script will be downloaded.") + " " +T("[required]"))
 
 	//#nosec G104 -- This is a false positive
 	cobraCmd.MarkFlagRequired("name")

plugin/commands/cdn/edit.go

@@ -75,7 +75,7 @@ func (cmd *EditCommand) Run(args []string) error {
 	if cmd.Cache != "" {
 		allowCache := []string{"include-all", "ignore-all", "include-specified", "ignore-specified"}
 		if !utils.WordInList(allowCache, cmd.Cache) {
-			return slErr.NewInvalidUsageError(T("Option cache just accept: " + utils.ArrayStringToString(allowCache)))
+			return slErr.NewInvalidUsageError(T("Option cache just accept: ") + utils.ArrayStringToString(allowCache))
 		}
 		if cmd.Cache == "include-specified" || cmd.Cache == "ignore-specified" {
 			if cmd.CacheDescription == "" {
@@ -93,7 +93,7 @@ func (cmd *EditCommand) Run(args []string) error {
 	if cmd.PerformanceConfiguration != "" {
 		allowPerformanceConfiguration := []string{"General web delivery", "Large file optimization", "Video on demand optimization"}
 		if !utils.WordInList(allowPerformanceConfiguration, cmd.PerformanceConfiguration) {
-			return slErr.NewInvalidUsageError(T("Option performance-configuration just accept: " + utils.ArrayStringToString(allowPerformanceConfiguration)))
+			return slErr.NewInvalidUsageError(T("Option performance-configuration just accept: ") + utils.ArrayStringToString(allowPerformanceConfiguration))
 		}
 	}
 

plugin/commands/hardware/notifications_add.go

@@ -56,7 +56,7 @@ func (cmd *NotificationsAddCommand) Run(args []string) error {
 		UserCustomerNotification, err := cmd.HardwareManager.CreateUserCustomerNotification(hardwareId, userId)
 		if err != nil {
 			userIdMap := map[string]interface{}{"userID": userId}
-			cmd.UI.Failed(T("Failed to create User Customer Notification with user ID: {{.userID}}."+"\n"+err.Error(), userIdMap))
+			cmd.UI.Failed(T("Failed to create User Customer Notification with user ID: {{.userID}}."), userIdMap)
 		} else {
 			printTable = true
 			table.Add(

plugin/commands/meta/meta.go

@@ -30,7 +30,7 @@ func NewMetaCommand(sl *metadata.SoftlayerCommand) *MetaCommand {
 	cobraCmd := &cobra.Command{
 		Use:       "metadata " + T("ARGUMENT"),
 		Short:     T("Find details about the machine making these API calls."),
-		Long:      T("ARGUMENT Choices: " + strings.Join(validOptions, ", ")),
+		Long:      T("ARGUMENT Choices: ") + strings.Join(validOptions, ", "),
 		Args:      cobra.MatchAll(metadata.OneArgs, cobra.OnlyValidArgs),
 		ValidArgs: validOptions,
 		RunE: func(cmd *cobra.Command, args []string) error {

plugin/commands/user/edit_notifications.go

@@ -67,7 +67,7 @@ func (cmd *EditNotificationsCommand) Run(args []string) error {
 
 	allNotifications, err := cmd.UserManager.GetAllNotifications("mask[id,name]")
 	if err != nil {
-		return slErr.NewAPIError(T("Failed to update notifications: "+printNotifications(notificationsInput)+"\n"), err.Error(), 2)
+		return slErr.NewAPIError(T("Failed to update notifications: ") + printNotifications(notificationsInput), err.Error(), 2)
 	}
 
 	if len(cmd.Disable) != 0 {
@@ -91,11 +91,12 @@ func (cmd *EditNotificationsCommand) Run(args []string) error {
 
 	if len(succesNotifications) > 0 {
 		cmd.UI.Ok()
-		cmd.UI.Print(T("Notifications updated successfully: " + printNotifications(succesNotifications)))
+		cmd.UI.Print(T("Notifications updated successfully: ") + printNotifications(succesNotifications))
 	}
 
 	if len(failedNotifications) > 0 {
-		cmd.UI.Print(T("Notifications updated unsuccessfully: " + printNotifications(failedNotifications) + ". Review if already set or if the name is correct."))
+		cmd.UI.Print(T("Notifications updated unsuccessfully: ") + printNotifications(failedNotifications))
+		cmd.UI.Print(T("Review if already set or if the name is correct."))
 	}
 
 	return nil

plugin/commands/user/vpn_manual.go

@@ -55,25 +55,22 @@ func (cmd *VpnManualCommand) Run(args []string) error {
 	}
 
 	vpnManualConfig := false
-	action := "disable"
 	if cmd.Enable {
 		vpnManualConfig = true
-		action = "enable"
 	}
 
 	userTemplate := datatypes.User_Customer{
 		VpnManualConfig: sl.Bool(vpnManualConfig),
 	}
 
-	mapValue := map[string]interface{}{"action": T(action)}
 
 	success, err := cmd.UserManager.EditUser(userTemplate, userID)
 	if err != nil {
-		return errors.NewInvalidUsageError(T("Failed to {{.action}} user vpn subnets manual config", mapValue))
+		return errors.NewInvalidUsageError(T("Failed to update user vpn subnets manual config"))
 	}
 	if success {
 		cmd.UI.Ok()
-		cmd.UI.Print(T("Successfully {{.action}} user vpn subnets manual config", mapValue))
+		cmd.UI.Print(T("Successfully updated user vpn subnets manual config"))
 	}
 	return nil
 }

plugin/commands/virtual/notifications_add.go

@@ -56,7 +56,7 @@ func (cmd *NotificationsAddCommand) Run(args []string) error {
 		UserCustomerNotification, err := cmd.VirtualServerManager.CreateUserCustomerNotification(virtualServerId, userId)
 		if err != nil {
 			userIdMap := map[string]interface{}{"userID": userId}
-			cmd.UI.Failed(T("Failed to create User Customer Notification with user ID: {{.userID}}."+"\n"+err.Error(), userIdMap))
+			cmd.UI.Failed(T("Failed to create User Customer Notification with user ID: {{.userID}}", userIdMap), err.Error(), 2)
 		} else {
 			printTable = true
 			table.Add(