make placement of colons consistent

EliteBGS/CHANGELOG.md

@@ -1,5 +1,12 @@
 # EliteBGS changelog
 
+## 0.4.2 on 02.05.2024
+
+* Add a bot header for all generated logs that shows the tool version, as
+  well as the name of of the log format used. This makes it easier for bots
+  to parse these logs. Since the different formats have become popular, its
+  always good to make it easier for bots to parse the logs.
+
 ## 0.4.1 on 28.04.2024
 
 * Filter out vouchers that are redeemed twice, due to bulk turn-in. If you

EliteBGS/DiscordLogGenerator.cs

@@ -111,10 +111,6 @@ public class DiscordLogGenerator {
 
         string summary = GenerateSummary(objective);
 
-        log.AppendFormat("**Log Generated:** {0} by {1}\n", 
-            DateTime.Now.ToString("dd/MM/yyyy"),
-            GetToolVersion()
-            );
         var earliest = GetDateOfEarliestEntry(objective);
         var latest = GetDateOfLatestEntry(objective);
         if (earliest != null && latest != null) {
@@ -125,7 +121,7 @@ public class DiscordLogGenerator {
         }
         log.AppendFormat("**Target:** {0}\n", location);
         if (!string.IsNullOrEmpty(summary)) {
-            log.AppendFormat("**Summary**: {0}\n", summary);
+            log.AppendFormat("**Summary:** {0}\n", summary);
         }
         if (legacycount > 0) {
             log.AppendFormat("**Warning:** Some actions were performed on ED Legacy\n");
@@ -149,6 +145,16 @@ public class DiscordLogGenerator {
         return log;
     }
 
+    public virtual string Name {
+        get { return "GenericLog"; }
+    }
+
+    protected virtual string BotHeader() {
+        var sb = new StringBuilder();
+        sb.AppendFormat("**Bot-Header:** {0}; {1}\n", GetToolVersion(), this.Name);
+        return sb.ToString();
+    }
+
     public virtual string GenerateDiscordLog(Report report) {
         StringBuilder log = new StringBuilder();
 
@@ -164,6 +170,7 @@ public class DiscordLogGenerator {
             return "";
         }
 
+        log.AppendFormat("{0}", BotHeader());
         log.AppendFormat("{0}", GenerateHeader());
 
         foreach (Objective objective in objectives) {

EliteBGS/EliteBGS.csproj

@@ -2,7 +2,7 @@
   <PropertyGroup>
     <TargetFramework>net7.0-windows</TargetFramework>
     <OutputType>WinExe</OutputType>
-    <Version>0.4.1</Version>
+    <Version>0.4.2</Version>
     <GenerateAssemblyInfo>false</GenerateAssemblyInfo>
     <UseWindowsForms>true</UseWindowsForms>
     <UseWPF>true</UseWPF>

EliteBGS/GenericDiscordLog.cs

@@ -2,6 +2,10 @@
 
 public class GenericDiscordLog : DiscordLogGenerator {
     public override string ToString() {
-        return "Generic Log";
+        return "Generic";
+    }
+
+    public override string Name {
+        get { return "Generic"; }
     }
 }

EliteBGS/MainWindow.xaml.cs

@@ -32,8 +32,8 @@ public partial class MainWindow : MetroWindow {
     private LoadEntriesWindow loadentries = null;
 
     private static readonly List<DiscordLogGenerator> logtypes = new List<DiscordLogGenerator>() {
-        new NonaDiscordLog(),
         new GenericDiscordLog(),
+        new NonaDiscordLog(),
         new OneLineDiscordLog(),
     };
 

EliteBGS/NonaDiscordLog.cs

@@ -7,6 +7,12 @@ using System.Linq;
 namespace EliteBGS.BGS;
 
 public class NonaDiscordLog : DiscordLogGenerator {
+    protected override string BotHeader() {
+        var sb = new StringBuilder();
+        sb.AppendFormat(":robot: `Bot-Header:` {0}; {1}\n", GetToolVersion(), this.Name);
+        return sb.ToString();
+    }
+
     private string FormatDate() {
         CultureInfo cultureInfo = CultureInfo.InvariantCulture;
         StringBuilder date = new StringBuilder();
@@ -79,6 +85,10 @@ public class NonaDiscordLog : DiscordLogGenerator {
     }
 
     public override string ToString() {
-        return "Nova Navy Log";
+        return "Nova Navy";
+    }
+
+    public override string Name {
+        get { return "NovaNavy"; }
     }
 }

EliteBGS/OneLineDiscordLog.cs

@@ -40,6 +40,8 @@ public class OneLineDiscordLog : DiscordLogGenerator {
             return "";
         }
 
+        log.AppendFormat("{0}", BotHeader());
+
         foreach (Objective objective in objectives) {
             log.AppendFormat("{0}", GenerateObjectiveHeader(objective));
 
@@ -60,6 +62,10 @@ public class OneLineDiscordLog : DiscordLogGenerator {
     }
 
     public override string ToString() {
-        return "One Line Report";
+        return "One Line";
+    }
+
+    public override string Name {
+        get { return "OneLine"; }
     }
 }

EliteBGS/Properties/AssemblyInfo.cs

@@ -49,5 +49,5 @@ using System.Windows;
 // You can specify all the values or you can default the Build and Revision Numbers
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("0.4.1.0")]
-[assembly: AssemblyFileVersion("0.4.1.0")]
+[assembly: AssemblyVersion("0.4.2.0")]
+[assembly: AssemblyFileVersion("0.4.2.0")]