Merge pull request #472 from LogExperts/persister_in_json

Changes the persistence files to json files, for better readability, but also for the future, older persistence files will no longer be loaded

Author: Hirogen

TODOs.txt

@@ -0,0 +1,2 @@
+Add Copilot Instruction txt
+Add Copilot HELP md for description what it does

src/CsvColumnizer/CsvColumnizer.cs

@@ -93,7 +93,7 @@ public string[] GetColumnNames ()
         if (_isValidCsv)
         {
             var i = 0;
-            foreach (CsvColumn column in _columnList)
+            foreach (var column in _columnList)
             {
                 names[i++] = column.Name;
             }
@@ -156,7 +156,7 @@ public void Selected (ILogLineColumnizerCallback callback)
         if (_isValidCsv) // see PreProcessLine()
         {
             _columnList.Clear();
-            ILogLine line = _config.HasFieldNames ? _firstLine : callback.GetLogLine(0);
+            var line = _config.HasFieldNames ? _firstLine : callback.GetLogLine(0);
 
             if (line != null)
             {
@@ -241,7 +241,7 @@ public void LoadConfig (string configDir)
 
     public Priority GetPriority (string fileName, IEnumerable<ILogLine> samples)
     {
-        Priority result = Priority.NotSupport;
+        var result = Priority.NotSupport;
 
         if (fileName.EndsWith("csv", StringComparison.OrdinalIgnoreCase))
         {

src/FlashIconHighlighter/FlashIconPlugin.cs

@@ -20,7 +20,7 @@ internal class FlashIconPlugin : IKeywordAction
 
     public void Execute (string keyword, string param, ILogExpertCallback callback, ILogLineColumnizer columnizer)
     {
-        FormCollection openForms = Application.OpenForms;
+        var openForms = Application.OpenForms;
         foreach (Form form in openForms)
         {
             if (form.TopLevel && form.Name.Equals("LogTabWindow", StringComparison.OrdinalIgnoreCase) && form.Text.Contains(callback.GetFileName(), StringComparison.Ordinal))

src/GlassfishColumnizer/GlassfishColumnizer.cs

@@ -76,7 +76,7 @@ public IColumnizedLogLine SplitLine (ILogLineColumnizerCallback callback, ILogLi
 
         var temp = line.FullLine;
 
-        Column[] columns = Column.CreateColumns(COLUMN_COUNT, cLogLine);
+        var columns = Column.CreateColumns(COLUMN_COUNT, cLogLine);
         cLogLine.ColumnValues = columns.Select(a => a as IColumn).ToArray();
 
         // delete '[#|' and '|#]'
@@ -100,7 +100,7 @@ public IColumnizedLogLine SplitLine (ILogLineColumnizerCallback callback, ILogLi
         {
             try
             {
-                DateTime dateTime = GetTimestamp(callback, line);
+                var dateTime = GetTimestamp(callback, line);
                 if (dateTime == DateTime.MinValue)
                 {
                     columns[1].FullValue = temp;
@@ -114,7 +114,7 @@ public IColumnizedLogLine SplitLine (ILogLineColumnizerCallback callback, ILogLi
                 columns[0].FullValue = "n/a";
             }
 
-            Column timestmp = columns[0];
+            var timestmp = columns[0];
 
             string[] cols;
             cols = temp.Split(trimChars, COLUMN_COUNT, StringSplitOptions.None);
@@ -180,7 +180,7 @@ public DateTime GetTimestamp (ILogLineColumnizerCallback callback, ILogLine logL
         try
         {
             // convert glassfish timestamp into a readable format:
-            if (DateTime.TryParseExact(value, DATETIME_FORMAT, cultureInfo, DateTimeStyles.None, out DateTime timestamp))
+            if (DateTime.TryParseExact(value, DATETIME_FORMAT, cultureInfo, DateTimeStyles.None, out var timestamp))
             {
                 return timestamp.AddMilliseconds(timeOffset);
             }

src/JsonColumnizer/JsonColumnizer.cs

@@ -1,7 +1,3 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-
 using LogExpert;
 
 using Newtonsoft.Json;
@@ -31,11 +27,11 @@ public virtual void Selected (ILogLineColumnizerCallback callback)
         ColumnList.Clear();
         ColumnSet.Clear();
 
-        ILogLine line = callback.GetLogLine(0);
+        var line = callback.GetLogLine(0);
 
         if (line != null)
         {
-            JObject json = ParseJson(line);
+            var json = ParseJson(line);
             if (json != null)
             {
                 var fieldCount = json.Properties().Count();
@@ -87,7 +83,7 @@ public virtual string[] GetColumnNames ()
     {
         var names = new string[GetColumnCount()];
         var i = 0;
-        foreach (JsonColumn column in ColumnList)
+        foreach (var column in ColumnList)
         {
             names[i++] = column.Name;
         }
@@ -97,7 +93,7 @@ public virtual string[] GetColumnNames ()
 
     public virtual IColumnizedLogLine SplitLine (ILogLineColumnizerCallback callback, ILogLine line)
     {
-        JObject json = ParseJson(line);
+        var json = ParseJson(line);
 
         if (json != null)
         {
@@ -106,7 +102,7 @@ public virtual IColumnizedLogLine SplitLine (ILogLineColumnizerCallback callback
 
         var cLogLine = new ColumnizedLogLine { LogLine = line };
 
-        Column[] columns = Column.CreateColumns(ColumnList.Count, cLogLine);
+        var columns = Column.CreateColumns(ColumnList.Count, cLogLine);
 
         columns.Last().FullValue = line.FullLine;
 
@@ -142,7 +138,7 @@ public virtual void PushValue (ILogLineColumnizerCallback callback, int column,
 
     public virtual Priority GetPriority (string fileName, IEnumerable<ILogLine> samples)
     {
-        Priority result = Priority.NotSupport;
+        var result = Priority.NotSupport;
         if (fileName.EndsWith("json", StringComparison.OrdinalIgnoreCase))
         {
             result = Priority.WellSupport;
@@ -159,7 +155,8 @@ protected static JObject ParseJson (ILogLine line)
     {
         return JsonConvert.DeserializeObject<JObject>(line.FullLine, new JsonSerializerSettings()
         {
-            Error = (sender, args) => { args.ErrorContext.Handled = true; } //We ignore the error and handle the null value
+            //We ignore the error and handle the null value
+            Error = (sender, args) => args.ErrorContext.Handled = true
         });
     }
 
@@ -179,7 +176,7 @@ protected virtual IColumnizedLogLine SplitJsonLine (ILogLine line, JObject json)
 
         var columns = json.Properties().Select(property => new ColumnWithName { FullValue = property.Value.ToString(), ColumnName = property.Name.ToString(), Parent = cLogLine }).ToList();
 
-        foreach (ColumnWithName jsonColumn in columns)
+        foreach (var jsonColumn in columns)
         {
             // When find new column in a log line, add a new column in the end of the list.
             if (!ColumnSet.Contains(jsonColumn.ColumnName))
@@ -195,13 +192,13 @@ protected virtual IColumnizedLogLine SplitJsonLine (ILogLine line, JObject json)
         }
 
         //
-        // Always rearrage the order of all json fields within a line to follow the sequence of columnNameList.
+        // Always rearrange the order of all json fields within a line to follow the sequence of columnNameList.
         // This will make sure the log line displayed correct even the order of json fields changed.
         //
         List<IColumn> returnColumns = [];
-        foreach (JsonColumn column in ColumnList)
+        foreach (var column in ColumnList)
         {
-            ColumnWithName existingColumn = columns.Find(x => x.ColumnName == column.Name);
+            var existingColumn = columns.Find(x => x.ColumnName == column.Name);
             if (existingColumn != null)
             {
                 returnColumns.Add(new Column() { FullValue = existingColumn.FullValue, Parent = cLogLine });

src/JsonCompactColumnizer/JsonCompactColumnizer.cs

@@ -38,7 +38,7 @@ public override void Selected (ILogLineColumnizerCallback callback)
 
     public override Priority GetPriority (string fileName, IEnumerable<ILogLine> samples)
     {
-        Priority result = Priority.NotSupport;
+        var result = Priority.NotSupport;
         if (fileName.EndsWith("json", StringComparison.OrdinalIgnoreCase))
         {
             result = Priority.WellSupport;
@@ -49,7 +49,7 @@ public override Priority GetPriority (string fileName, IEnumerable<ILogLine> sam
             try
             {
                 var line = samples.First();
-                JObject json = ParseJson(line);
+                var json = ParseJson(line);
                 if (json != null)
                 {
                     var columns = SplitJsonLine(samples.First(), json);
@@ -98,7 +98,7 @@ protected override IColumnizedLogLine SplitJsonLine (ILogLine line, JObject json
         {
             if (column.StartsWith('@'))
             {
-                ColumnWithName existingColumn = columns.Find(x => x.ColumnName == column);
+                var existingColumn = columns.Find(x => x.ColumnName == column);
 
                 if (existingColumn != null)
                 {

src/Log4jXmlColumnizer/Log4jXmlColumnizer.cs

@@ -82,7 +82,7 @@ public IColumnizedLogLine SplitLine (ILogLineColumnizerCallback callback, ILogLi
         ColumnizedLogLine clogLine = new();
         clogLine.LogLine = line;
 
-        Column[] columns = Column.CreateColumns(COLUMN_COUNT, clogLine);
+        var columns = Column.CreateColumns(COLUMN_COUNT, clogLine);
 
         // If the line is too short (i.e. does not follow the format for this columnizer) return the whole line content
         // in colum 8 (the log message column). Date and time column will be left blank.
@@ -94,7 +94,7 @@ public IColumnizedLogLine SplitLine (ILogLineColumnizerCallback callback, ILogLi
         {
             try
             {
-                DateTime dateTime = GetTimestamp(callback, line);
+                var dateTime = GetTimestamp(callback, line);
 
                 if (dateTime == DateTime.MinValue)
                 {
@@ -109,7 +109,7 @@ public IColumnizedLogLine SplitLine (ILogLineColumnizerCallback callback, ILogLi
                 columns[0].FullValue = "n/a";
             }
 
-            Column timestmp = columns[0];
+            var timestmp = columns[0];
 
             string[] cols;
             cols = line.FullLine.Split(trimChars, COLUMN_COUNT, StringSplitOptions.None);
@@ -137,7 +137,7 @@ public IColumnizedLogLine SplitLine (ILogLineColumnizerCallback callback, ILogLi
             }
         }
 
-        Column[] filteredColumns = MapColumns(columns);
+        var filteredColumns = MapColumns(columns);
 
         clogLine.ColumnValues = filteredColumns.Select(a => a as IColumn).ToArray();
 
@@ -174,6 +174,7 @@ public DateTime GetTimestamp (ILogLineColumnizerCallback callback, ILogLine line
         {
             return DateTime.MinValue;
         }
+
         var value = line.FullLine.Substring(0, endIndex);
 
         try
@@ -189,6 +190,7 @@ public DateTime GetTimestamp (ILogLineColumnizerCallback callback, ILogLine line
                 {
                     dateTime = dateTime.ToLocalTime();
                 }
+
                 return dateTime.AddMilliseconds(_timeOffset);
             }
             else
@@ -264,11 +266,12 @@ public void LoadConfig (string configDir)
 
     public Priority GetPriority (string fileName, IEnumerable<ILogLine> samples)
     {
-        Priority result = Priority.NotSupport;
+        var result = Priority.NotSupport;
         if (fileName.EndsWith("xml", StringComparison.OrdinalIgnoreCase))
         {
             result = Priority.CanSupport;
         }
+
         return result;
     }
 
@@ -287,18 +290,19 @@ private Column[] MapColumns (Column[] cols)
     {
         List<Column> output = [];
         var index = 0;
-        foreach (Log4jColumnEntry entry in _config.ColumnList)
+        foreach (var entry in _config.ColumnList)
         {
             if (entry.Visible)
             {
-                Column column = cols[index];
+                var column = cols[index];
                 output.Add(column);
 
                 if (entry.MaxLen > 0 && column.FullValue.Length > entry.MaxLen)
                 {
                     column.FullValue = column.FullValue[^entry.MaxLen..];
                 }
             }
+
             index++;
         }
 

src/Log4jXmlColumnizer/Log4jXmlColumnizerConfig.cs

@@ -26,7 +26,7 @@ public int ActiveColumnCount
         get
         {
             var count = 0;
-            foreach (Log4jColumnEntry entry in ColumnList)
+            foreach (var entry in ColumnList)
             {
                 if (entry.Visible)
                 {
@@ -47,7 +47,7 @@ public string[] ActiveColumnNames
         {
             var names = new string[ActiveColumnCount];
             var index = 0;
-            foreach (Log4jColumnEntry entry in ColumnList)
+            foreach (var entry in ColumnList)
             {
                 if (entry.Visible)
                 {

src/Log4jXmlColumnizer/Log4jXmlColumnizerConfigDlg.cs

@@ -1,4 +1,4 @@
-using Log4jXmlColumnizer;
+using Log4jXmlColumnizer;
 
 using System;
 using System.Drawing;
@@ -39,7 +39,7 @@ private void FillListBox()
         var nameColumn = (DataGridViewTextBoxColumn)columnGridView.Columns[1];
         var lenColumn = (DataGridViewTextBoxColumn)columnGridView.Columns[2];
 
-        foreach (Log4jColumnEntry entry in _config.ColumnList)
+        foreach (var entry in _config.ColumnList)
         {
             DataGridViewRow row = new();
             row.Cells.Add(new DataGridViewCheckBoxCell());
@@ -76,6 +76,7 @@ private void OkButton_Click(object sender, EventArgs e)
                 _config.ColumnList[i].MaxLen = 0;
             }
         }
+
         _config.LocalTimestamps = localTimeCheckBox.Checked;
     }
 

src/LogExpert.Core/Classes/Bookmark/BookmarkDataProvider.cs

@@ -87,7 +87,7 @@ public void ShiftBookmarks (int offset)
     {
         SortedList<int, Entities.Bookmark> newBookmarkList = [];
 
-        foreach (Entities.Bookmark bookmark in BookmarkList.Values)
+        foreach (var bookmark in BookmarkList.Values)
         {
             var line = bookmark.LineNum - offset;
             if (line >= 0)
@@ -102,7 +102,7 @@ public void ShiftBookmarks (int offset)
 
     public int FindPrevBookmarkIndex (int lineNum)
     {
-        IList<Entities.Bookmark> values = BookmarkList.Values;
+        var values = BookmarkList.Values;
         for (var i = BookmarkList.Count - 1; i >= 0; --i)
         {
             if (values[i].LineNum <= lineNum)
@@ -116,14 +116,15 @@ public int FindPrevBookmarkIndex (int lineNum)
 
     public int FindNextBookmarkIndex (int lineNum)
     {
-        IList<Entities.Bookmark> values = BookmarkList.Values;
+        var values = BookmarkList.Values;
         for (var i = 0; i < BookmarkList.Count; ++i)
         {
             if (values[i].LineNum >= lineNum)
             {
                 return i;
             }
         }
+
         return 0;
     }