Merge pull request #486 from LogExperts/plugin-repository-optimizations

Plugin repository rework and optimizations

Author: Hirogen

.github/workflows/build_dotnet.yml

@@ -10,26 +10,32 @@ on:
 
 env:
   Solution: src/LogExpert.sln
-  Test_Project: src/LogExpert.Tests/LogExpert.Tests.csproj
+  Test_Project_LogExpert: src/LogExpert.Tests/LogExpert.Tests.csproj
+  Test_Project_ColumnizerLib: src/ColumnizerLib.UnitTests/ColumnizerLib.UnitTests.csproj
+  Test_Project_PluginRegistry: src/PluginRegistry.Tests/PluginRegistry.Tests.csproj
+  Test_Project_RegexColumnizer: src/RegexColumnizer.UnitTests/RegexColumnizer.UnitTests.csproj
 
 jobs:
   build:
-    permissions: 
-      contents: read
-    
+    permissions:
+      contents: write  # Changed to 'write' for committing
+      pull-requests: write  # Added for PR operations
+
     strategy:
       fail-fast: false
       matrix:
         configuration: [Debug, Release]
-        
+
     runs-on: windows-latest
     name: Build Application - ${{ matrix.configuration }}
-    
+
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+          ref: ${{ github.head_ref }}  # Checkout the PR branch
 
       - name: Install .NET Core
         uses: actions/setup-dotnet@v4
@@ -40,6 +46,24 @@ jobs:
         run: |
           dotnet build ${{ env.Solution }} --nologo -v quiet -c ${{ matrix.configuration }}
 
+      - name: Generate Plugin Hashes
+        if: matrix.configuration == 'Release'
+        run: dotnet run --project src/PluginHashGenerator.Tool/PluginHashGenerator.Tool.csproj -- "bin/Release/" "src/PluginRegistry/PluginHashGenerator.Generated.cs" Release
+
+      - name: Commit Updated Hashes
+        if: matrix.configuration == 'Release'
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add src/PluginRegistry/PluginHashGenerator.Generated.cs
+          git diff --staged --quiet
+          if ($LASTEXITCODE -ne 0) {
+            git commit -m "chore: update plugin hashes [skip ci]"
+            git push
+          } else {
+            Write-Host "No changes to commit"
+          }
+
       - name: Upload artifact
         uses: actions/upload-artifact@v4
         with:

README.md

@@ -4,7 +4,7 @@ This is a clone from (no longer exists) <https://logexpert.codeplex.com/>
 
 ## Overview
 
-LogExpert is a Windows tail program (a GUI replacement for the Unix tail command).
+LogExpert is a Windows feature rich tail program (a GUI replacement for the Unix tail command) with support for plugins, highlighting, filtering, bookmarking, columnizing and more.
 
 Summary of (most) features:
 

build/_build.csproj

@@ -12,12 +12,13 @@
   <ItemGroup>
     <PackageReference Include="chocolatey" Version="2.5.1" />
     <PackageReference Include="GitVersion.Core" Version="6.5.0" />
-    <PackageReference Include="Microsoft.Build" Version="17.14.28" />
-    <PackageReference Include="Microsoft.Build.Tasks.Core" Version="17.14.28" />
-    <PackageReference Include="NuGet.CommandLine" Version="6.14.0">
+    <PackageReference Include="Microsoft.Build" Version="18.0.2" />
+    <PackageReference Include="Microsoft.Build.Tasks.Core" Version="18.0.2" />
+    <PackageReference Include="NuGet.CommandLine" Version="7.0.0">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
     </PackageReference>
+    <PackageReference Include="NuGet.Versioning" Version="7.0.0" />
     <PackageReference Include="Nuke.Common" Version="9.0.4" />
     <PackageReference Include="Nuke.GitHub" Version="7.0.0" />
     <PackageReference Include="NUnit.ConsoleRunner" Version="3.20.2" />

src/AutoColumnizer/AutoColumnizer.cs

@@ -1,7 +1,7 @@
-using LogExpert;
-
 using System;
 
+using LogExpert;
+
 namespace AutoColumnizer;
 
 public class AutoColumnizer : ILogLineColumnizer
@@ -10,53 +10,53 @@ public class AutoColumnizer : ILogLineColumnizer
 
     public string Text => GetName();
 
-    public bool IsTimeshiftImplemented()
+    public bool IsTimeshiftImplemented ()
     {
         return true;
     }
 
-    public string GetName()
+    public string GetName ()
     {
         return "Auto Columnizer";
     }
 
-    public string GetDescription()
+    public string GetDescription ()
     {
         return "Automatically find the right columnizer for any file";
     }
 
 
-    public int GetColumnCount()
+    public int GetColumnCount ()
     {
         throw new NotImplementedException();
     }
 
-    public string[] GetColumnNames()
+    public string[] GetColumnNames ()
     {
         throw new NotImplementedException();
     }
 
-    public IColumnizedLogLine SplitLine(ILogLineColumnizerCallback callback, ILogLine line)
+    public IColumnizedLogLine SplitLine (ILogLineColumnizerCallback callback, ILogLine line)
     {
         throw new NotImplementedException();
     }
 
-    public void SetTimeOffset(int msecOffset)
+    public void SetTimeOffset (int msecOffset)
     {
         throw new NotImplementedException();
     }
 
-    public int GetTimeOffset()
+    public int GetTimeOffset ()
     {
         throw new NotImplementedException();
     }
 
-    public DateTime GetTimestamp(ILogLineColumnizerCallback callback, ILogLine line)
+    public DateTime GetTimestamp (ILogLineColumnizerCallback callback, ILogLine line)
     {
         throw new NotImplementedException();
     }
 
-    public void PushValue(ILogLineColumnizerCallback callback, int column, string value, string oldValue)
+    public void PushValue (ILogLineColumnizerCallback callback, int column, string value, string oldValue)
     {
     }
 

src/AutoColumnizer/AutoColumnizer.csproj

@@ -10,4 +10,10 @@
     <ProjectReference Include="..\ColumnizerLib\ColumnizerLib.csproj" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Update="AutoColumnizer.manifest.json">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+  </ItemGroup>
+
 </Project>

src/AutoColumnizer/AutoColumnizer.manifest.json

@@ -0,0 +1,19 @@
+{
+  "name": "AutoColumnizer",
+  "version": "1.0.0",
+  "author": "LogExpert Team",
+  "description": "Automatically detects and applies the appropriate columnizer for any log file format",
+  "apiVersion": "1.0",
+  "requires": {
+    "logExpert": ">=1.20.0",
+    "dotnet": "10.0"
+  },
+  "permissions": [
+    "filesystem:read",
+    "config:read"
+  ],
+  "dependencies": {},
+  "main": "AutoColumnizer.dll",
+  "url": "https://github.com/LogExperts/LogExpert",
+  "license": "MIT"
+}

src/ColumnizerLib/Column.cs

@@ -1,7 +1,9 @@
 using System;
 using System.Collections.Generic;
 
-namespace LogExpert;
+using LogExpert;
+
+namespace ColumnizerLib;
 
 public class Column : IColumn
 {

src/ColumnizerLib/ILogExpertLogger.cs

@@ -1,8 +1,3 @@
-using System;
-using System.Collections.Generic;
-using System.Globalization;
-using System.Text;
-
 namespace LogExpert;
 
 /// <summary>
@@ -17,29 +12,35 @@ public interface ILogExpertLogger
     /// The logger in LogExpert will automatically add the class and the method name of the caller.
     /// </summary>
     /// <param name="msg">A message to be logged.</param>
-    void Info(string msg);
+    void Info (string msg);
+
+    /// <summary>
+    /// Writes an informational message using the specified format provider.
+    /// </summary>
+    /// <param name="formatProvider">An object that supplies culture-specific formatting information for the message. Cannot be null.</param>
+    /// <param name="msg">The informational message to write. Cannot be null.</param>
     void Info (IFormatProvider formatProvider, string msg);
 
     /// <summary>
     /// Logs a message on DEBUG level to LogExpert#s log file. The logfile is only active in debug builds.
     /// The logger in LogExpert will automatically add the class and the method name of the caller.
     /// </summary>
     /// <param name="msg">A message to be logged.</param>
-    void Debug(string msg);
+    void Debug (string msg);
 
     /// <summary>
     /// Logs a message on WARN level to LogExpert#s log file. The logfile is only active in debug builds.
     /// The logger in LogExpert will automatically add the class and the method name of the caller.
     /// </summary>
     /// <param name="msg">A message to be logged.</param>
-    void LogWarn(string msg);
+    void LogWarn (string msg);
 
     /// <summary>
     /// Logs a message on ERROR level to LogExpert#s log file. The logfile is only active in debug builds.
     /// The logger in LogExpert will automatically add the class and the method name of the caller.
     /// </summary>
     /// <param name="msg">A message to be logged.</param>
-    void LogError(string msg);
+    void LogError (string msg);
 
     #endregion
 }

src/ColumnizerLib/IPluginContext.cs

@@ -0,0 +1,28 @@
+namespace LogExpert;
+
+/// <summary>
+/// Provides context information to plugins during initialization.
+/// </summary>
+public interface IPluginContext
+{
+    /// <summary>
+    /// Logger for the plugin to use for diagnostic output.
+    /// </summary>
+    ILogExpertLogger Logger { get; }
+    
+    /// <summary>
+    /// Directory where the plugin assembly is located.
+    /// </summary>
+    string PluginDirectory { get; }
+    
+    /// <summary>
+    /// Version of the host application (LogExpert).
+    /// </summary>
+    Version HostVersion { get; }
+    
+    /// <summary>
+    /// Directory where the plugin can store configuration files.
+    /// Typically %APPDATA%\LogExpert\Plugins\{PluginName}\
+    /// </summary>
+    string ConfigurationDirectory { get; }
+}

src/ColumnizerLib/IPluginLifecycle.cs

@@ -0,0 +1,27 @@
+namespace LogExpert;
+
+/// <summary>
+/// Defines lifecycle events for plugins.
+/// Plugins can optionally implement this interface to receive lifecycle notifications.
+/// </summary>
+public interface IPluginLifecycle
+{
+    /// <summary>
+    /// Called when the plugin is first loaded.
+    /// Use this to initialize resources, load configuration, etc.
+    /// </summary>
+    /// <param name="context">Context providing information about the host environment</param>
+    void Initialize (IPluginContext context);
+
+    /// <summary>
+    /// Called when the application is shutting down.
+    /// Use this to cleanup resources, save state, etc.
+    /// </summary>
+    void Shutdown ();
+
+    /// <summary>
+    /// Called when the plugin should reload its configuration.
+    /// Use this to refresh settings without restarting the application.
+    /// </summary>
+    void Reload ();
+}