Cleanup.

Author: Oren (electricessence)

.editorconfig

@@ -0,0 +1,16 @@
+[*.cs]
+
+# CA1707: Identifiers should not contain underscores
+dotnet_diagnostic.CA1707.severity = silent
+
+# CA1303: Do not pass literals as localized parameters
+dotnet_diagnostic.CA1303.severity = silent
+
+# CA1051: Do not declare visible instance fields
+dotnet_diagnostic.CA1051.severity = silent
+
+# CA1063: Implement IDisposable Correctly
+dotnet_diagnostic.CA1063.severity = silent
+
+# CA1816: Dispose methods should call SuppressFinalize
+dotnet_diagnostic.CA1816.severity = silent

AsyncDisposableBase.cs

@@ -1,6 +1,6 @@
 /*!
  * @author electricessence / https://github.com/electricessence/
- * Licensing: MIT https://github.com/electricessence/Open.Disposable/blob/master/LISCENSE.md
+ * Licensing: MIT https://github.com/Open-NET-Libraries/Open.Disposable/blob/master/LICENSE.md
  */
 
 using System.Threading.Tasks;
@@ -56,7 +56,7 @@ private async ValueTask OnDisposeAsyncInternal(ValueTask onDispose)
 		{
 			try
 			{
-				await onDispose;
+				await onDispose.ConfigureAwait(false);
 			}
 			finally
 			{

AsyncDisposeHandler.cs

@@ -1,6 +1,6 @@
 /*!
  * @author electricessence / https://github.com/electricessence/
- * Licensing: MIThttps://github.com/electricessence/Open.Disposable/blob/master/LISCENSE.md
+ * Licensing: MIT https://github.com/Open-NET-Libraries/Open.Disposable/blob/master/LICENSE.md
  */
 
 using System;

DeferredCleanupBase.cs

@@ -1,6 +1,6 @@
 /*!
  * @author electricessence / https://github.com/electricessence/
- * Licensing: MIThttps://github.com/electricessence/Open.Disposable/blob/master/LISCENSE.md
+ * Licensing: MIT https://github.com/Open-NET-Libraries/Open.Disposable/blob/master/LICENSE.md
  */
 
 using System;
@@ -100,7 +100,9 @@ public void SetCleanup(CleanupMode mode = CleanupMode.Deferred)
 							// No past due action in order to prevent another thread from firing...
 							LastCleanup = DateTime.MaxValue;
 							DeferCleanup();
-							Task.Factory.StartNew(() => Cleanup());
+#pragma warning disable CA2008 // Last cleanup value protects against repeat task creation.
+							Task.Factory.StartNew(Cleanup);
+#pragma warning restore CA2008
 						}
 					}
 					break;
@@ -119,7 +121,7 @@ public void DeferCleanup()
 				if (WasDisposed) return;
 				IsRunning = true;
 
-				if (_cleanupTimer == null)
+				if (_cleanupTimer is null)
 					_cleanupTimer = new Timer(Cleanup, null, _cleanupDelay, Timeout.Infinite);
 				else
 					_cleanupTimer.Change(_cleanupDelay, Timeout.Infinite);
@@ -138,7 +140,8 @@ public void ClearCleanup()
 			}
 		}
 
-		private void Cleanup(object? state = null)
+		private void Cleanup() => Cleanup(null);
+		private void Cleanup(object? state)
 		{
 			if (WasDisposed)
 				return; // If another thread enters here after disposal don't allow.
@@ -147,10 +150,12 @@ private void Cleanup(object? state = null)
 			{
 				OnCleanup();
 			}
+#pragma warning disable CA1031 // Do not catch general exception types
 			catch (Exception ex)
 			{
 				Debug.WriteLine(ex.ToString());
 			}
+#pragma warning restore CA1031 // Do not catch general exception types
 
 			lock (_timerSync)
 			{

DisposableBase.cs

@@ -1,6 +1,6 @@
 /*!
  * @author electricessence / https://github.com/electricessence/
- * Licensing: MIThttps://github.com/electricessence/Open.Disposable/blob/master/LISCENSE.md
+ * Licensing: MIT https://github.com/Open-NET-Libraries/Open.Disposable/blob/master/LICENSE.md
  */
 
 using System;

DisposableStateBase.cs

@@ -1,6 +1,6 @@
 /*!
  * @author electricessence / https://github.com/electricessence/
- * Licensing: MIThttps://github.com/electricessence/Open.Disposable/blob/master/LISCENSE.md
+ * Licensing: MIT https://github.com/Open-NET-Libraries/Open.Disposable/blob/master/LICENSE.md
  */
 
 using System;

DisposeHandler.cs

@@ -1,6 +1,6 @@
 /*!
  * @author electricessence / https://github.com/electricessence/
- * Licensing: MIThttps://github.com/electricessence/Open.Disposable/blob/master/LISCENSE.md
+ * Licensing: MIT https://github.com/Open-NET-Libraries/Open.Disposable/blob/master/LICENSE.md
  */
 
 using System;

Extensions.cs

@@ -1,6 +1,6 @@
 /*!
  * @author electricessence / https://github.com/electricessence/
- * Licensing: MIThttps://github.com/electricessence/Open.Disposable/blob/master/LISCENSE.md
+ * Licensing: MIT https://github.com/Open-NET-Libraries/Open.Disposable/blob/master/LICENSE.md
  */
 
 using System;
@@ -14,9 +14,8 @@ public static class DisposableExtensions
 	{
 		public static bool AssertIsAlive(this IDisposalState state)
 		{
-			if (state.WasDisposed)
-				throw new ObjectDisposedException(state.GetType().ToString());
-
+			if (state is null) throw new ArgumentNullException(nameof(state));
+			if (state.WasDisposed) throw new ObjectDisposedException(state.GetType().ToString());
 			return true;
 		}
 
@@ -26,8 +25,7 @@ public static bool AssertIsAlive(this IDisposalState state)
 		/// <param name="target"></param>
 		public static void DisposeAll(this IEnumerable<IDisposable> target)
 		{
-			if (target == null)
-				throw new ArgumentNullException(nameof(target));
+			if (target is null) throw new ArgumentNullException(nameof(target));
 			Contract.EndContractBlock();
 
 			foreach (var d in target)
@@ -42,7 +40,7 @@ public static void DisposeAll(this IEnumerable<IDisposable> target)
 		/// <param name="disposeContents">If true, will dispose of each item (if disposable) before calling clear.</param>
 		public static void Dispose<T>(this ICollection<T> target, bool disposeContents = false)
 		{
-			if (target == null) return;
+			if (target is null) return;
 
 			// Disposing of each may trigger events that cause removal of from the underlying collection so allow for that before clearing the collection.
 			if (disposeContents)

Open.Disposable.csproj

@@ -15,7 +15,7 @@ Part of the "Open" set of libraries.
     <PackageProjectUrl>https://github.com/Open-NET-Libraries/Open.Disposable/</PackageProjectUrl>
     <RepositoryUrl>https://github.com/Open-NET-Libraries/Open.Disposable/</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
-    <Version>2.3.3</Version>
+    <Version>2.4.0</Version>
     <PackageReleaseNotes></PackageReleaseNotes>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
 		<PublishRepositoryUrl>true</PublishRepositoryUrl>
@@ -31,8 +31,6 @@ Part of the "Open" set of libraries.
   <ItemGroup>
     <None Remove=".git" />
     <None Remove=".gitignore" />
-    <None Remove="LISCENSE.md" />
-    <None Remove="README.md"/>
     <None Include="logo.png">
       <Pack>True</Pack>
       <PackagePath></PackagePath>
@@ -43,4 +41,11 @@ Part of the "Open" set of libraries.
     <PackageReference Include="System.Threading.Tasks.Extensions" Version="4.5.4" />
   </ItemGroup>
 
+	<ItemGroup>
+		<PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="3.0.0">
+			<PrivateAssets>all</PrivateAssets>
+			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+		</PackageReference>
+	</ItemGroup>
+
 </Project>