address code violations

- ran dotnet format severity --info which set fields to readonly when appropriate and fixed spacing
- made methods that did not access instanced variables static
- since this was moved to net6.0 with nullable enabled, fields that were nullable have been properly declared as nullable
- addressed naming rule violations in Demo

Author: PhantomGamers

Source/Demo/Form1.Designer.cs

@@ -14,7 +14,7 @@ public Form1()
 
 
 
-        private void btnStart_Click(object sender, EventArgs e)
+        private void BtnStart_Click(object sender, EventArgs e)
         {
             _fw = new FileSystemWatcherEx(txtPath.Text.Trim());
 
@@ -34,7 +34,7 @@ private void btnStart_Click(object sender, EventArgs e)
             btnStop.Enabled = true;
         }
 
-        private void FW_OnError(object sender, ErrorEventArgs e)
+        private void FW_OnError(object? sender, ErrorEventArgs e)
         {
             if (txtConsole.InvokeRequired)
             {
@@ -46,28 +46,28 @@ private void FW_OnError(object sender, ErrorEventArgs e)
             }
         }
 
-        private void FW_OnChanged(object sender, FileChangedEvent e)
+        private void FW_OnChanged(object? sender, FileChangedEvent e)
         {
             txtConsole.Text += string.Format("[cha] {0} | {1}",
                 Enum.GetName(typeof(ChangeType), e.ChangeType),
                 e.FullPath) + "\r\n";
         }
 
-        private void FW_OnDeleted(object sender, FileChangedEvent e)
+        private void FW_OnDeleted(object? sender, FileChangedEvent e)
         {
             txtConsole.Text += string.Format("[del] {0} | {1}",
                 Enum.GetName(typeof(ChangeType), e.ChangeType),
                 e.FullPath) + "\r\n";
         }
 
-        private void FW_OnCreated(object sender, FileChangedEvent e)
+        private void FW_OnCreated(object? sender, FileChangedEvent e)
         {
             txtConsole.Text += string.Format("[cre] {0} | {1}",
                 Enum.GetName(typeof(ChangeType), e.ChangeType),
                 e.FullPath) + "\r\n";
         }
 
-        private void FW_OnRenamed(object sender, FileChangedEvent e)
+        private void FW_OnRenamed(object? sender, FileChangedEvent e)
         {
             txtConsole.Text += string.Format("[ren] {0} | {1} ----> {2}",
                 Enum.GetName(typeof(ChangeType), e.ChangeType),
@@ -77,7 +77,7 @@ private void FW_OnRenamed(object sender, FileChangedEvent e)
 
 
 
-        private void btnStop_Click(object sender, EventArgs e)
+        private void BtnStop_Click(object sender, EventArgs e)
         {
             _fw.Stop();
 
@@ -88,7 +88,7 @@ private void btnStop_Click(object sender, EventArgs e)
         }
 
 
-        private void btnSelectFolder_Click(object sender, EventArgs e)
+        private void BtnSelectFolder_Click(object sender, EventArgs e)
         {
             var fb = new FolderBrowserDialog();
 

Source/Demo/Form1.cs

@@ -25,7 +25,7 @@ public class FileChangedEvent
     /// <summary>
     /// The old full path (used if ChangeType = RENAMED)
     /// </summary>
-    public string OldFullPath { get; set; } = "";
+    public string? OldFullPath { get; set; } = "";
 }
 
 

Source/FileWatcherEx/FileEvents.cs

@@ -9,15 +9,15 @@ public class FileSystemWatcherEx : IDisposable
 
     #region Private Properties
 
-    private Thread _thread;
-    private EventProcessor _processor;
-    private BlockingCollection<FileChangedEvent> _fileEventQueue = new();
+    private Thread? _thread;
+    private EventProcessor? _processor;
+    private readonly BlockingCollection<FileChangedEvent> _fileEventQueue = new();
 
     private FileWatcher _watcher = new();
     private FileSystemWatcher _fsw = new();
 
     // Define the cancellation token.
-    private CancellationTokenSource _cancelSource = new();
+    private readonly CancellationTokenSource _cancelSource = new();
 
     #endregion
 
@@ -52,27 +52,27 @@ public class FileSystemWatcherEx : IDisposable
     /// <summary>
     /// Gets or sets the object used to marshal the event handler calls issued as a result of a directory change.
     /// </summary>
-    public ISynchronizeInvoke SynchronizingObject { get; set; }
+    public ISynchronizeInvoke? SynchronizingObject { get; set; }
 
     #endregion
 
 
 
     #region Public Events
-    public delegate void DelegateOnChanged(object sender, FileChangedEvent e);
-    public event DelegateOnChanged OnChanged;
+    public delegate void DelegateOnChanged(object? sender, FileChangedEvent e);
+    public event DelegateOnChanged? OnChanged;
 
-    public delegate void DelegateOnDeleted(object sender, FileChangedEvent e);
-    public event DelegateOnDeleted OnDeleted;
+    public delegate void DelegateOnDeleted(object? sender, FileChangedEvent e);
+    public event DelegateOnDeleted? OnDeleted;
 
-    public delegate void DelegateOnCreated(object sender, FileChangedEvent e);
-    public event DelegateOnCreated OnCreated;
+    public delegate void DelegateOnCreated(object? sender, FileChangedEvent e);
+    public event DelegateOnCreated? OnCreated;
 
-    public delegate void DelegateOnRenamed(object sender, FileChangedEvent e);
-    public event DelegateOnRenamed OnRenamed;
+    public delegate void DelegateOnRenamed(object? sender, FileChangedEvent e);
+    public event DelegateOnRenamed? OnRenamed;
 
-    public delegate void DelegateOnError(object sender, ErrorEventArgs e);
-    public event DelegateOnError OnError;
+    public delegate void DelegateOnError(object? sender, ErrorEventArgs e);
+    public event DelegateOnError? OnError;
     #endregion
 
 
@@ -103,7 +103,7 @@ public void Start()
 
                     InvokeChangedEvent(SynchronizingObject, e);
 
-                    void InvokeChangedEvent(object sender, FileChangedEvent fileEvent)
+                    void InvokeChangedEvent(object? sender, FileChangedEvent fileEvent)
                     {
                         if (SynchronizingObject != null && SynchronizingObject.InvokeRequired)
                         {
@@ -122,7 +122,7 @@ void InvokeChangedEvent(object sender, FileChangedEvent fileEvent)
 
                     InvokeCreatedEvent(SynchronizingObject, e);
 
-                    void InvokeCreatedEvent(object sender, FileChangedEvent fileEvent)
+                    void InvokeCreatedEvent(object? sender, FileChangedEvent fileEvent)
                     {
                         if (SynchronizingObject != null && SynchronizingObject.InvokeRequired)
                         {
@@ -141,7 +141,7 @@ void InvokeCreatedEvent(object sender, FileChangedEvent fileEvent)
 
                     InvokeDeletedEvent(SynchronizingObject, e);
 
-                    void InvokeDeletedEvent(object sender, FileChangedEvent fileEvent)
+                    void InvokeDeletedEvent(object? sender, FileChangedEvent fileEvent)
                     {
                         if (SynchronizingObject != null && SynchronizingObject.InvokeRequired)
                         {
@@ -160,7 +160,7 @@ void InvokeDeletedEvent(object sender, FileChangedEvent fileEvent)
 
                     InvokeRenamedEvent(SynchronizingObject, e);
 
-                    void InvokeRenamedEvent(object sender, FileChangedEvent fileEvent)
+                    void InvokeRenamedEvent(object? sender, FileChangedEvent fileEvent)
                     {
                         if (SynchronizingObject != null && SynchronizingObject.InvokeRequired)
                         {
@@ -232,7 +232,7 @@ private void Thread_DoingWork(CancellationToken cancelToken)
             try
             {
                 var e = _fileEventQueue.Take(cancelToken);
-                _processor.ProcessEvent(e);
+                _processor?.ProcessEvent(e);
             }
             catch (OperationCanceledException)
             {
@@ -260,7 +260,7 @@ public void Stop()
         // stop the thread
         _cancelSource.Cancel();
     }
-    
+
 
 
     /// <summary>
@@ -271,6 +271,7 @@ public void Dispose()
         if (_fsw != null)
         {
             _fsw.Dispose();
+            GC.SuppressFinalize(this);
         }
     }
 

Source/FileWatcherEx/FileSystemWatcherEx.cs

@@ -10,20 +10,20 @@ internal class EventProcessor
     /// <summary>
     /// Aggregate and only emit events when changes have stopped for this duration (in ms)
     /// </summary>
-    private static int EVENT_DELAY = 50;
+    private static readonly int EVENT_DELAY = 50;
 
     /// <summary>
     /// Warn after certain time span of event spam (in ticks)
     /// </summary>
-    private static int EVENT_SPAM_WARNING_THRESHOLD = 60 * 1000 * 10000;
+    private static readonly int EVENT_SPAM_WARNING_THRESHOLD = 60 * 1000 * 10000;
 
-    private System.Object LOCK = new System.Object();
-    private Task delayTask = null;
+    private readonly System.Object LOCK = new();
+    private Task? delayTask = null;
 
-    private List<FileChangedEvent> events = new List<FileChangedEvent>();
-    private Action<FileChangedEvent> handleEvent;
+    private readonly List<FileChangedEvent> events = new();
+    private readonly Action<FileChangedEvent> handleEvent;
 
-    private Action<string> logger;
+    private readonly Action<string> logger;
 
     private long lastEventTime = 0;
     private long delayStarted = 0;
@@ -32,7 +32,7 @@ internal class EventProcessor
     private bool spamWarningLogged = false;
 
 
-    private IEnumerable<FileChangedEvent> NormalizeEvents(FileChangedEvent[] events)
+    private static IEnumerable<FileChangedEvent> NormalizeEvents(FileChangedEvent[] events)
     {
         var mapPathToEvents = new Dictionary<string, FileChangedEvent>();
         var eventsWithoutDuplicates = new List<FileChangedEvent>();
@@ -64,7 +64,7 @@ private IEnumerable<FileChangedEvent> NormalizeEvents(FileChangedEvent[] events)
                 { // If <ANY> + RENAMED
                     do
                     {
-                        mapPathToEvents.TryGetValue(newEvent.OldFullPath, out var renameFromEvent); // Try get event from newEvent.OldFullPath
+                        mapPathToEvents.TryGetValue(newEvent.OldFullPath!, out var renameFromEvent); // Try get event from newEvent.OldFullPath
 
                         if (renameFromEvent != null && renameFromEvent.ChangeType == ChangeType.CREATED)
                         { // If rename from CREATED file
@@ -135,10 +135,10 @@ private IEnumerable<FileChangedEvent> NormalizeEvents(FileChangedEvent[] events)
                     if (deletedPaths.Any(d => IsParent(e.Value.FullPath, d)))
                     {
                         return false; // DELETE is ignored if parent is deleted already
-                        }
+                    }
 
-                        // otherwise mark as deleted
-                        deletedPaths.Add(e.Value.FullPath);
+                    // otherwise mark as deleted
+                    deletedPaths.Add(e.Value.FullPath);
                 }
 
                 return true;
@@ -148,7 +148,7 @@ private IEnumerable<FileChangedEvent> NormalizeEvents(FileChangedEvent[] events)
     }
 
 
-    private bool IsParent(string p, string candidate)
+    private static bool IsParent(string p, string candidate)
     {
         return p.IndexOf(candidate + '\\') == 0;
     }
@@ -189,35 +189,34 @@ public void ProcessEvent(FileChangedEvent fileEvent)
             if (delayTask == null)
             {
                 // Create function to buffer events
-                Action<Task> func = null;
-                func = (Task value) =>
+                void func(Task value)
                 {
                     lock (LOCK)
                     {
-                            // Check if another event has been received in the meantime
-                            if (delayStarted == lastEventTime)
+                        // Check if another event has been received in the meantime
+                        if (delayStarted == lastEventTime)
                         {
-                                // Normalize and handle
-                                var normalized = NormalizeEvents(events.ToArray());
+                            // Normalize and handle
+                            var normalized = NormalizeEvents(events.ToArray());
                             foreach (var e in normalized)
                             {
                                 handleEvent(e);
                             }
 
-                                // Reset
-                                events.Clear();
+                            // Reset
+                            events.Clear();
                             delayTask = null;
                         }
 
-                            // Otherwise we have received a new event while this task was
-                            // delayed and we reschedule it.
-                            else
+                        // Otherwise we have received a new event while this task was
+                        // delayed and we reschedule it.
+                        else
                         {
                             delayStarted = lastEventTime;
                             delayTask = Task.Delay(EVENT_DELAY).ContinueWith(func);
                         }
                     }
-                };
+                }
 
                 // Start function after delay
                 delayStarted = lastEventTime;

Source/FileWatcherEx/Helpers/EventProcessor.cs

@@ -9,7 +9,7 @@ internal class FileWatcher : IDisposable
 {
     private string _watchPath = string.Empty;
     private Action<FileChangedEvent>? _eventCallback = null;
-    private Dictionary<string, FileSystemWatcher> _fwDictionary = new();
+    private readonly Dictionary<string, FileSystemWatcher> _fwDictionary = new();
     private Action<ErrorEventArgs>? _onError = null;