Merge #3880 Correctly print cmdline errors with braces

HebaruSan · HebaruSan · commit 9d0b75ed63bf · 2023-08-15T08:53:51.000-05:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -18,6 +18,7 @@ All notable changes to this project will be documented in this file.
 - [Core] Add missing resource string for upgrading (#3873 by: HebaruSan; reviewed: techman83)
 - [Multiple] Repository management fixes (#3876 by: HebaruSan; reviewed: techman83)
 - [GUI] Restore window position without default instance (#3878 by: HebaruSan; reviewed: techman83)
+- [CLI] Correctly print cmdline errors with braces (#3880 by: HebaruSan; reviewed: techman83)
 
 ### Internal
 
diff --git a/Cmdline/Action/AuthToken.cs b/Cmdline/Action/AuthToken.cs
@@ -110,7 +110,7 @@ private int addAuthToken(AddAuthTokenOptions opts)
             }
             else
             {
-                user.RaiseError("Invalid host name: {0}", opts.host);
+                user.RaiseError(Properties.Resources.AuthTokenInvalidHostName, opts.host);
             }
             return Exit.OK;
         }
diff --git a/Cmdline/Action/GameInstance.cs b/Cmdline/Action/GameInstance.cs
@@ -637,21 +637,21 @@ int badArgument()
             catch (BadInstallLocationKraken kraken)
             {
                 // The folder exists and is not empty.
-                User.RaiseError(kraken.Message);
+                User.RaiseError("{0}", kraken.Message);
                 return badArgument();
             }
             catch (WrongGameVersionKraken kraken)
             {
                 // Thrown because the specified game instance is too old for one of the selected DLCs.
-                User.RaiseError(kraken.Message);
+                User.RaiseError("{0}", kraken.Message);
                 return badArgument();
             }
             catch (NotKSPDirKraken kraken)
             {
                 // Something went wrong adding the new instance to the registry,
                 // most likely because the newly created directory is somehow not valid.
                 log.Error(kraken);
-                User.RaiseError(kraken.Message);
+                User.RaiseError("{0}", kraken.Message);
                 return error();
             }
             catch (InvalidKSPInstanceKraken)
diff --git a/Cmdline/Action/Install.cs b/Cmdline/Action/Install.cs
@@ -88,9 +88,10 @@ public int RunCommand(CKAN.GameInstance instance, object raw_options)
                     }
                     catch (Kraken kraken)
                     {
-                        user.RaiseError(kraken.InnerException == null
-                            ? kraken.Message
-                            : $"{kraken.Message}: {kraken.InnerException.Message}");
+                        user.RaiseError("{0}",
+                            kraken.InnerException == null
+                                ? kraken.Message
+                                : $"{kraken.Message}: {kraken.InnerException.Message}");
                     }
                 }
 
@@ -142,7 +143,7 @@ public int RunCommand(CKAN.GameInstance instance, object raw_options)
                 }
                 catch (DependencyNotSatisfiedKraken ex)
                 {
-                    user.RaiseError(ex.Message);
+                    user.RaiseError("{0}", ex.Message);
                     user.RaiseMessage(Properties.Resources.InstallTryAgain);
                     return Exit.ERROR;
                 }
@@ -214,7 +215,7 @@ public int RunCommand(CKAN.GameInstance instance, object raw_options)
                 catch (InconsistentKraken ex)
                 {
                     // The prettiest Kraken formats itself for us.
-                    user.RaiseError(ex.InconsistenciesPretty);
+                    user.RaiseError("{0}", ex.InconsistenciesPretty);
                     user.RaiseMessage(Properties.Resources.InstallCancelled);
                     return Exit.ERROR;
                 }
@@ -226,12 +227,12 @@ public int RunCommand(CKAN.GameInstance instance, object raw_options)
                 catch (MissingCertificateKraken kraken)
                 {
                     // Another very pretty kraken.
-                    user.RaiseError(kraken.ToString());
+                    user.RaiseError("{0}", kraken.ToString());
                     return Exit.ERROR;
                 }
                 catch (DownloadThrottledKraken kraken)
                 {
-                    user.RaiseError(kraken.ToString());
+                    user.RaiseError("{0}", kraken.ToString());
                     user.RaiseMessage(Properties.Resources.InstallTryAuthToken, kraken.infoUrl);
                     return Exit.ERROR;
                 }
@@ -242,12 +243,12 @@ public int RunCommand(CKAN.GameInstance instance, object raw_options)
                 }
                 catch (ModuleDownloadErrorsKraken kraken)
                 {
-                    user.RaiseError(kraken.ToString());
+                    user.RaiseError("{0}", kraken.ToString());
                     return Exit.ERROR;
                 }
                 catch (DirectoryNotFoundKraken kraken)
                 {
-                    user.RaiseError(kraken.Message);
+                    user.RaiseError("{0}", kraken.Message);
                     return Exit.ERROR;
                 }
                 catch (ModuleIsDLCKraken kraken)
diff --git a/Cmdline/Main.cs b/Cmdline/Main.cs
@@ -331,7 +331,7 @@ private static int Scan(CKAN.GameInstance inst, IUser user, string next_command
 
                 if (next_command == null)
                 {
-                    user.RaiseError(kraken.InconsistenciesPretty);
+                    user.RaiseError("{0}", kraken.InconsistenciesPretty);
                     user.RaiseError(Properties.Resources.ScanNotSaved);
                 }
                 else
diff --git a/Cmdline/Properties/Resources.Designer.cs b/Cmdline/Properties/Resources.Designer.cs
diff --git a/Cmdline/Properties/Resources.resx b/Cmdline/Properties/Resources.resx
@@ -154,6 +154,7 @@ Update recommended!</value></data>
   <data name="AuthTokenHostHeader" xml:space="preserve"><value>Host</value></data>
   <data name="AuthTokenTokenHeader" xml:space="preserve"><value>Token</value></data>
   <data name="AuthTokenHelpSummary" xml:space="preserve"><value>Manage authentication tokens</value></data>
+  <data name="AuthTokenInvalidHostName" xml:space="preserve"><value>Invalid host name: {0}</value></data>
   <data name="AvailableHeader" xml:space="preserve"><value>Modules compatible with {0} {1}</value></data>
   <data name="CacheHelpSummary" xml:space="preserve"><value>Manage the download cache path of CKAN</value></data>
   <data name="CacheSet" xml:space="preserve"><value>Download cache set to {0}</value></data>

Original file line number	Diff line number	Diff line change
`@@ -110,7 +110,7 @@ private int addAuthToken(AddAuthTokenOptions opts)`
`110`	`110`	`}`
`111`	`111`	`else`
`112`	`112`	`{`
`113`		`- user.RaiseError("Invalid host name: {0}", opts.host);`
	`113`	`+ user.RaiseError(Properties.Resources.AuthTokenInvalidHostName, opts.host);`
`114`	`114`	`}`
`115`	`115`	`return Exit.OK;`
`116`	`116`	`}`
Original file line number	Diff line number	Diff line change
`@@ -637,21 +637,21 @@ int badArgument()`
`637`	`637`	`catch (BadInstallLocationKraken kraken)`
`638`	`638`	`{`
`639`	`639`	`// The folder exists and is not empty.`
`640`		`- User.RaiseError(kraken.Message);`
	`640`	`+ User.RaiseError("{0}", kraken.Message);`
`641`	`641`	`return badArgument();`
`642`	`642`	`}`
`643`	`643`	`catch (WrongGameVersionKraken kraken)`
`644`	`644`	`{`
`645`	`645`	`// Thrown because the specified game instance is too old for one of the selected DLCs.`
`646`		`- User.RaiseError(kraken.Message);`
	`646`	`+ User.RaiseError("{0}", kraken.Message);`
`647`	`647`	`return badArgument();`
`648`	`648`	`}`
`649`	`649`	`catch (NotKSPDirKraken kraken)`
`650`	`650`	`{`
`651`	`651`	`// Something went wrong adding the new instance to the registry,`
`652`	`652`	`// most likely because the newly created directory is somehow not valid.`
`653`	`653`	`log.Error(kraken);`
`654`		`- User.RaiseError(kraken.Message);`
	`654`	`+ User.RaiseError("{0}", kraken.Message);`
`655`	`655`	`return error();`
`656`	`656`	`}`
`657`	`657`	`catch (InvalidKSPInstanceKraken)`
Original file line number	Diff line number	Diff line change
`@@ -88,9 +88,10 @@ public int RunCommand(CKAN.GameInstance instance, object raw_options)`
`88`	`88`	`}`
`89`	`89`	`catch (Kraken kraken)`
`90`	`90`	`{`
`91`		`- user.RaiseError(kraken.InnerException == null`
`92`		`- ? kraken.Message`
`93`		`- : $"{kraken.Message}: {kraken.InnerException.Message}");`
	`91`	`+ user.RaiseError("{0}",`
	`92`	`+ kraken.InnerException == null`
	`93`	`+ ? kraken.Message`
	`94`	`+ : $"{kraken.Message}: {kraken.InnerException.Message}");`
`94`	`95`	`}`
`95`	`96`	`}`
`96`	`97`
`@@ -142,7 +143,7 @@ public int RunCommand(CKAN.GameInstance instance, object raw_options)`
`142`	`143`	`}`
`143`	`144`	`catch (DependencyNotSatisfiedKraken ex)`
`144`	`145`	`{`
`145`		`- user.RaiseError(ex.Message);`
	`146`	`+ user.RaiseError("{0}", ex.Message);`
`146`	`147`	`user.RaiseMessage(Properties.Resources.InstallTryAgain);`
`147`	`148`	`return Exit.ERROR;`
`148`	`149`	`}`
`@@ -214,7 +215,7 @@ public int RunCommand(CKAN.GameInstance instance, object raw_options)`
`214`	`215`	`catch (InconsistentKraken ex)`
`215`	`216`	`{`
`216`	`217`	`// The prettiest Kraken formats itself for us.`
`217`		`- user.RaiseError(ex.InconsistenciesPretty);`
	`218`	`+ user.RaiseError("{0}", ex.InconsistenciesPretty);`
`218`	`219`	`user.RaiseMessage(Properties.Resources.InstallCancelled);`
`219`	`220`	`return Exit.ERROR;`
`220`	`221`	`}`
`@@ -226,12 +227,12 @@ public int RunCommand(CKAN.GameInstance instance, object raw_options)`
`226`	`227`	`catch (MissingCertificateKraken kraken)`
`227`	`228`	`{`
`228`	`229`	`// Another very pretty kraken.`
`229`		`- user.RaiseError(kraken.ToString());`
	`230`	`+ user.RaiseError("{0}", kraken.ToString());`
`230`	`231`	`return Exit.ERROR;`
`231`	`232`	`}`
`232`	`233`	`catch (DownloadThrottledKraken kraken)`
`233`	`234`	`{`
`234`		`- user.RaiseError(kraken.ToString());`
	`235`	`+ user.RaiseError("{0}", kraken.ToString());`
`235`	`236`	`user.RaiseMessage(Properties.Resources.InstallTryAuthToken, kraken.infoUrl);`
`236`	`237`	`return Exit.ERROR;`
`237`	`238`	`}`
`@@ -242,12 +243,12 @@ public int RunCommand(CKAN.GameInstance instance, object raw_options)`
`242`	`243`	`}`
`243`	`244`	`catch (ModuleDownloadErrorsKraken kraken)`
`244`	`245`	`{`
`245`		`- user.RaiseError(kraken.ToString());`
	`246`	`+ user.RaiseError("{0}", kraken.ToString());`
`246`	`247`	`return Exit.ERROR;`
`247`	`248`	`}`
`248`	`249`	`catch (DirectoryNotFoundKraken kraken)`
`249`	`250`	`{`
`250`		`- user.RaiseError(kraken.Message);`
	`251`	`+ user.RaiseError("{0}", kraken.Message);`
`251`	`252`	`return Exit.ERROR;`
`252`	`253`	`}`
`253`	`254`	`catch (ModuleIsDLCKraken kraken)`
Original file line number	Diff line number	Diff line change
`@@ -331,7 +331,7 @@ private static int Scan(CKAN.GameInstance inst, IUser user, string next_command`
`331`	`331`
`332`	`332`	`if (next_command == null)`
`333`	`333`	`{`
`334`		`- user.RaiseError(kraken.InconsistenciesPretty);`
	`334`	`+ user.RaiseError("{0}", kraken.InconsistenciesPretty);`
`335`	`335`	`user.RaiseError(Properties.Resources.ScanNotSaved);`
`336`	`336`	`}`
`337`	`337`	`else`