basic diagnostics, logger next

Author: mf366-dev

WriterSharp.PluginApi/Diagnostics/IPluginReporter.cs

@@ -0,0 +1,43 @@
+using System;
+
+
+namespace WriterSharp.PluginApi.Diagnostics
+{
+
+	/// <summary>
+	/// A state reporter for the plugin.
+	/// </summary>
+	public interface IPluginReporter
+	{
+
+		/// <summary>
+		/// Reports an issue.
+		/// </summary>
+		/// <param name="issue">The description of the issue</param>
+		/// <param name="severityLevel">The severity of the issue</param>
+		void Report(string issue, SeverityLevel severityLevel = SeverityLevel.None);
+
+		/// <summary>
+		/// Reports a missing dependency.
+		/// </summary>
+		/// <param name="dependency">The missing dependency's name</param>
+		/// <param name="severityLevel">The severity level of the issue</param>
+		void ReportMissingDependency(string dependency, SeverityLevel severityLevel = SeverityLevel.High);
+
+		/// <summary>
+		/// Reports a performance issue.
+		/// </summary>
+		/// <param name="description">The description of the issue</param>
+		/// <param name="expectedMs">An expected duration</param>
+		/// <param name="actualMs">The actual duration</param>
+		void ReportPerformanceIssue(string description, TimeSpan expectedMs, TimeSpan actualMs);
+
+		/// <summary>
+		/// Reports a critical vulnerability.
+		/// </summary>
+		/// <param name="description">The description opf the vulnerability</param>
+		void ReportVulnerability(string description);
+
+	}
+
+}

WriterSharp.PluginApi/Diagnostics/SeverityLevel.cs

@@ -0,0 +1,37 @@
+namespace WriterSharp.PluginApi.Diagnostics
+{
+
+	/// <summary>
+	/// The severity level of a diagnosis/issue.
+	/// </summary>
+	public enum SeverityLevel
+	{
+
+		/// <summary>
+		/// No severity at all.
+		/// </summary>
+		None,
+
+		/// <summary>
+		/// Information severity.
+		/// </summary>
+		Low,
+
+		/// <summary>
+		/// Warning severity.
+		/// </summary>
+		Medium,
+
+		/// <summary>
+		/// Error severity (non-critical).
+		/// </summary>
+		High,
+
+		/// <summary>
+		/// Error severity (critical).
+		/// </summary>
+		Critical
+
+	}
+
+}

…terSharp.PluginApi/System/IFileSystem.cs WriterSharp.PluginApi/IO/IFileSystem.csWriterSharp.PluginApi/System/IFileSystem.cs renamed to WriterSharp.PluginApi/IO/IFileSystem.cs WriterSharp.PluginApi/System/IFileSystem.cs renamed to WriterSharp.PluginApi/IO/IFileSystem.cs

@@ -3,7 +3,7 @@
 using System.Threading.Tasks;
 
 
-namespace WriterSharp.PluginApi.System
+namespace WriterSharp.PluginApi.IO
 {
 
 	/// <summary>

WriterSharp.PluginApi/IPluginContext.cs

@@ -1,7 +1,7 @@
-using WriterSharp.PluginApi.DependencyInjection;
-using WriterSharp.PluginApi.FileSystem;
-using WriterSharp.PluginApi.Resources;
+using WriterSharp.PluginApi.Diagnostics;
+using WriterSharp.PluginApi.IO;
 using WriterSharp.PluginApi.Settings;
+using WriterSharp.PluginApi.Sharing;
 
 
 namespace WriterSharp.PluginApi
@@ -13,12 +13,20 @@ namespace WriterSharp.PluginApi
 	public interface IPluginContext
 	{
 
-		// todo: add missing interfaces
+		/// <summary>
+		/// Manages commands that the user can call.
+		/// </summary>
+		ICommandManager Commands { get; }
 
 		/// <summary>
-		/// The WriterSharp resource manager, for communication between plugins.
+		/// Dependency container for WriterSharp.
 		/// </summary>
-		IResourceManager Resources { get; }
+		IDependencyContainer Dependencies { get; }
+
+		/// <summary>
+		/// Manages events related to WriterSharp.
+		/// </summary>
+		IEventManager Events { get; }
 
 		/// <summary>
 		/// The sharded, recommended way for plugins to access
@@ -27,40 +35,45 @@ public interface IPluginContext
 		IFileSystem FileSystem { get; }
 
 		/// <summary>
-		/// Manages languages loaded into WriterSharp.
+		/// Manages keyboard gestures loaded into WriterSharp.
 		/// </summary>
-		ILanguageManager Languages { get; }
+		IGestureManager Gestures { get; }
 
 		/// <summary>
-		/// Manages theming functionality loaded into
-		/// WriterSharp.
+		/// Reporter for issues, such as performance issues.
 		/// </summary>
-		IThemingManager Themes { get; }
+		IPluginReporter IssueReporter { get; }
 
 		/// <summary>
-		/// Manages events related to WriterSharp.
+		/// Manages languages loaded into WriterSharp.
 		/// </summary>
-		IEventManager Events { get; }
+		ILanguageManager Languages { get; }
 
 		/// <summary>
-		/// Manages keyboard gestures loaded into WriterSharp.
+		/// The WriterSharp logger.
 		/// </summary>
-		IGestureManager Gestures { get; }
+		ILogger Logger { get; }
 
 		/// <summary>
-		/// Manages commands that the user can call.
+		/// The WriterSharp resource manager, for communication between plugins.
 		/// </summary>
-		ICommandManager Commands { get; }
+		IResourceManager Resources { get; }
 
 		/// <summary>
 		/// Manages plugin's settings via WriterSharp (for security).
 		/// </summary>
 		ISettingsManager Settings { get; }
 
 		/// <summary>
-		/// Dependency injector for WriterSharp plugins.
+		/// Manages theming functionality loaded into
+		/// WriterSharp.
+		/// </summary>
+		IThemingManager Themes { get; }
+
+		/// <summary>
+		/// Disables the plugin.
 		/// </summary>
-		IDependencyInjector Dependencies { get; }
+		void Disable();
 
 	}
 

WriterSharp.PluginApi/Sharing/IService.cs

@@ -10,7 +10,7 @@ public interface IService
 		/// <summary>
 		/// Whether the service is available for public usage.
 		/// </summary>
-		bool IsAvailable { get; }
+		bool IsAvailable { get; set; }
 
 	}
 

docs/devlogs/archive/devlog1.md

@@ -8,7 +8,7 @@ Announcement
 First Devlog
 2 <- this means the previous button should not exist also only the first character from this line is read soo; a value of 3 means both buttons should be hidden
 
-Welcome to the very first WriterSharp devlog - now hosted in WriterSharp's brand new site.
+Welcome to the very first WriterSharp devlog - now hosted in WriterSharp's brand-new site.
 
 Yep, that's right, everyone! I've officially moved from the _tiny little section on my main site_ to a dedicated site just for WriterSharp. While still a work in progress - very much like the program itself - it allows me to connect, share updates and be transparent with those who are interested - or just curious - in WriterSharp's development and eventual release.