Documentation

inyutin-maxim · inyutin-maxim · commit 11bc7d11641b · 2019-03-30T23:21:53.000+03:00
diff --git a/System.IO.Abstractions.Analyzers/Analyzers/FileSystemTypeAnalyzers/DirectoryAnalyzer.cs b/System.IO.Abstractions.Analyzers/Analyzers/FileSystemTypeAnalyzers/DirectoryAnalyzer.cs
@@ -18,7 +18,7 @@ public class DirectoryAnalyzer : BaseFileSystemNodeAnalyzer
 		/// <summary>
 		/// Diagnostic Title
 		/// </summary>
-		private const string Title = "Replace Directory class with IFileSystem.Directory for improved testablity";
+		private const string Title = "Replace Directory class with IFileSystem.Directory for improved testability";
 
 		/// <summary>
 		/// Diagnostic Message Format
diff --git a/System.IO.Abstractions.Analyzers/Analyzers/FileSystemTypeAnalyzers/DirectoryInfoAnalyzer.cs b/System.IO.Abstractions.Analyzers/Analyzers/FileSystemTypeAnalyzers/DirectoryInfoAnalyzer.cs
@@ -18,7 +18,7 @@ public class DirectoryInfoAnalyzer: BaseFileSystemNodeAnalyzer
 		/// <summary>
 		/// Diagnostic Title
 		/// </summary>
-		private const string Title = "Replace DirectoryInfo class with IFileSystem.DirectoryInfo for improved testablity";
+		private const string Title = "Replace DirectoryInfo class with IFileSystem.DirectoryInfo for improved testability";
 
 		/// <summary>
 		/// Diagnostic Message Format
diff --git a/System.IO.Abstractions.Analyzers/Analyzers/FileSystemTypeAnalyzers/FileAnalyzer.cs b/System.IO.Abstractions.Analyzers/Analyzers/FileSystemTypeAnalyzers/FileAnalyzer.cs
@@ -18,7 +18,7 @@ public class FileAnalyzer : BaseFileSystemNodeAnalyzer
 		/// <summary>
 		/// Diagnostic Title
 		/// </summary>
-		private const string Title = "Replace File class with IFileSystem.File for improved testablity";
+		private const string Title = "Replace File class with IFileSystem.File for improved testability";
 
 		/// <summary>
 		/// Diagnostic Message Format
diff --git a/System.IO.Abstractions.Analyzers/Analyzers/FileSystemTypeAnalyzers/FileInfoAnalyzer.cs b/System.IO.Abstractions.Analyzers/Analyzers/FileSystemTypeAnalyzers/FileInfoAnalyzer.cs
@@ -18,7 +18,7 @@ public class FileInfoAnalyzer : BaseFileSystemNodeAnalyzer
 		/// <summary>
 		/// Diagnostic Title
 		/// </summary>
-		private const string Title = "Replace FileInfo class with IFileSystem.FileInfo for improved testablity";
+		private const string Title = "Replace FileInfo class with IFileSystem.FileInfo for improved testability";
 
 		/// <summary>
 		/// Diagnostic Message Format
diff --git a/System.IO.Abstractions.Analyzers/Analyzers/FileSystemTypeAnalyzers/FileStreamAnalyzer.cs b/System.IO.Abstractions.Analyzers/Analyzers/FileSystemTypeAnalyzers/FileStreamAnalyzer.cs
@@ -18,7 +18,7 @@ public class FileStreamAnalyzer : BaseFileSystemNodeAnalyzer
 		/// <summary>
 		/// Diagnostic Title
 		/// </summary>
-		private const string Title = "Replace FileStream class with IFileSystem.FileStream for improved testablity";
+		private const string Title = "Replace FileStream class with IFileSystem.FileStream for improved testability";
 
 		/// <summary>
 		/// Diagnostic Message Format
diff --git a/System.IO.Abstractions.Analyzers/Analyzers/FileSystemTypeAnalyzers/PathAnalyzer.cs b/System.IO.Abstractions.Analyzers/Analyzers/FileSystemTypeAnalyzers/PathAnalyzer.cs
@@ -18,7 +18,7 @@ public class PathAnalyzer : BaseFileSystemNodeAnalyzer
 		/// <summary>
 		/// Diagnostic Title
 		/// </summary>
-		private const string Title = "Replace Path class with IFileSystem.Path for improved testablity";
+		private const string Title = "Replace Path class with IFileSystem.Path for improved testability";
 
 		/// <summary>
 		/// Diagnostic Message Format
diff --git a/System.IO.Abstractions.Analyzers/Analyzers/FileSystemTypeAnalyzers/StringReaderAnalyzer.cs b/System.IO.Abstractions.Analyzers/Analyzers/FileSystemTypeAnalyzers/StringReaderAnalyzer.cs
@@ -18,7 +18,7 @@ public class StringReaderAnalyzer : BaseFileSystemNodeAnalyzer
 		/// <summary>
 		/// Diagnostic Title
 		/// </summary>
-		private const string Title = "Replace StringReader instances with IFileSystem.StringReader factory for improved testablity";
+		private const string Title = "Replace StringReader instances with IFileSystem.StringReader factory for improved testability";
 
 		/// <summary>
 		/// Diagnostic Message Format
diff --git a/System.IO.Abstractions.Analyzers/Analyzers/FileSystemTypeAnalyzers/StringWriterAnalyzer.cs b/System.IO.Abstractions.Analyzers/Analyzers/FileSystemTypeAnalyzers/StringWriterAnalyzer.cs
@@ -18,7 +18,7 @@ public class StringWriterAnalyzer : BaseFileSystemNodeAnalyzer
 		/// <summary>
 		/// Diagnostic Title
 		/// </summary>
-		private const string Title = "Replace StringWriter class with IFileSystem.StringWriter for improved testablity";
+		private const string Title = "Replace StringWriter class with IFileSystem.StringWriter for improved testability";
 
 		/// <summary>
 		/// Diagnostic Message Format
diff --git a/System.IO.Abstractions.Analyzers/CodeFixes/DirectoryCodeFix.cs b/System.IO.Abstractions.Analyzers/CodeFixes/DirectoryCodeFix.cs
@@ -10,6 +10,6 @@ public class DirectoryCodeFix : BaseInvokeCodeFix
 	{
 		protected override string DiagnosticId => Constants.Io0003;
 
-		protected override string Title => "Use IFileSystem.Directory for improved testablity";
+		protected override string Title => "Use IFileSystem.Directory for improved testability";
 	}
 }
diff --git a/System.IO.Abstractions.Analyzers/CodeFixes/DirectoryInfoCodeFix.cs b/System.IO.Abstractions.Analyzers/CodeFixes/DirectoryInfoCodeFix.cs
@@ -14,7 +14,7 @@ namespace System.IO.Abstractions.Analyzers.CodeFixes
 	[ExportCodeFixProvider(LanguageNames.CSharp, Name = nameof(DirectoryInfoCodeFix))]
 	public class DirectoryInfoCodeFix : CodeFixProvider
 	{
-		private const string Title = "Use IDirectoryInfoFactory instead creation DirectoryInfo for improved testablity";
+		private const string Title = "Use IDirectoryInfoFactory instead creation DirectoryInfo for improved testability";
 
 		public override ImmutableArray<string> FixableDiagnosticIds =>
 			ImmutableArray.Create(Constants.Io0007);
diff --git a/System.IO.Abstractions.Analyzers/CodeFixes/FileCodeFix.cs b/System.IO.Abstractions.Analyzers/CodeFixes/FileCodeFix.cs
@@ -10,6 +10,6 @@ public class FileCodeFix : BaseInvokeCodeFix
 	{
 		protected override string DiagnosticId => Constants.Io0002;
 
-		protected override string Title => "Use IFileSystem.File for improved testablity";
+		protected override string Title => "Use IFileSystem.File for improved testability";
 	}
 }
diff --git a/System.IO.Abstractions.Analyzers/CodeFixes/FileInfoCodeFix.cs b/System.IO.Abstractions.Analyzers/CodeFixes/FileInfoCodeFix.cs
@@ -14,7 +14,7 @@ namespace System.IO.Abstractions.Analyzers.CodeFixes
 	[ExportCodeFixProvider(LanguageNames.CSharp, Name = nameof(FileInfoCodeFix))]
 	public class FileInfoCodeFix : CodeFixProvider
 	{
-		private const string Title = "Use IFileInfoFactory instead creation FileInfo for improved testablity";
+		private const string Title = "Use IFileInfoFactory instead creation FileInfo for improved testability";
 
 		public override ImmutableArray<string> FixableDiagnosticIds =>
 			ImmutableArray.Create(Constants.Io0007);
diff --git a/System.IO.Abstractions.Analyzers/CodeFixes/FileStreamCodeFix.cs b/System.IO.Abstractions.Analyzers/CodeFixes/FileStreamCodeFix.cs
@@ -14,7 +14,7 @@ namespace System.IO.Abstractions.Analyzers.CodeFixes
 	[ExportCodeFixProvider(LanguageNames.CSharp, Name = nameof(FileStreamCodeFix))]
 	public class FileStreamCodeFix : CodeFixProvider
 	{
-		private const string Title = "Use IFileStreamFactory instead creation FileStream for improved testablity";
+		private const string Title = "Use IFileStreamFactory instead creation FileStream for improved testability";
 
 		public override ImmutableArray<string> FixableDiagnosticIds =>
 			ImmutableArray.Create(Constants.Io0005);
diff --git a/System.IO.Abstractions.Analyzers/CodeFixes/PathCodeFix.cs b/System.IO.Abstractions.Analyzers/CodeFixes/PathCodeFix.cs
@@ -10,6 +10,6 @@ public class PathCodeFix: BaseInvokeCodeFix
 	{
 		protected override string DiagnosticId => Constants.Io0006;
 
-		protected override string Title => "Use IFileSystem.Path for improved testablity";
+		protected override string Title => "Use IFileSystem.Path for improved testability";
 	}
 }
diff --git a/docs/IO0001.MD b/docs/IO0001.MD
@@ -0,0 +1,97 @@
+# IO0001. Use System.IO.Abstractions for improved application testability
+
+| Topic    | Value
+| :--      | :--
+| Id       | IO0001
+| Severity | Warning
+| Enabled  | True
+| Category | System.IO.Abstractions
+
+## Description
+
+Use System.IO.Abstractions for improved application testability
+
+## Code with Diagnostic
+
+``` csharp
+using System.IO;
+
+namespace SomeNameSpace
+{
+	public class WithOutFileSystem
+	{
+		public WithOutFileSystem()
+		{
+		}
+
+		public void SomeMethod()
+		{
+			const string filePath = "C:\\temp.txt";
+
+			if (File.Exists(filePath))
+			{
+				File.Delete(filePath);
+			}
+		}
+	}
+}
+```
+
+## Code with Fix
+
+###### Constructor injection
+``` csharp
+using System.IO.Abstractions;
+
+namespace SomeNameSpace
+{
+	public class WithOutFileSystem
+	{
+		private readonly IFileSystem _fileSystem;
+
+		public WithOutFileSystem(IFileSystem fileSystem)
+		{
+			_fileSystem = fileSystem;
+		}
+
+		public void SomeMethod()
+		{
+			const string filePath = "C:\\temp.txt";
+
+			if (File.Exists(filePath))
+			{
+				File.Delete(filePath);
+			}
+		}
+	}
+}
+```
+
+###### Creation in constructor
+
+```csharp
+using System.IO.Abstractions;
+
+namespace SomeNameSpace
+{
+	public class WithOutFileSystem
+	{
+		private readonly IFileSystem _fileSystem;
+
+		public WithOutFileSystem()
+		{
+			_fileSystem = new FileSystem();
+		}
+
+		public void SomeMethod()
+		{
+			const string filePath = "C:\\temp.txt";
+
+			if (File.Exists(filePath))
+			{
+				File.Delete(filePath);
+			}
+		}
+	}
+}
+```
diff --git a/docs/IO0002.MD b/docs/IO0002.MD
@@ -0,0 +1,64 @@
+# IO0002. Replace File class with IFileSystem.File for improved testability
+
+| Topic    | Value
+| :--      | :--
+| Id       | IO0002
+| Severity | Warning
+| Enabled  | True
+| Category | System.IO.Abstractions
+
+## Description
+
+Replace File class with IFileSystem.File for improved testability
+
+## Code with Diagnostic
+
+``` csharp
+using System.IO.Abstractions;
+
+namespace SomeNameSpace
+{
+	public class WithOutFileSystem
+	{
+		private readonly IFileSystem _fileSystem;
+
+		public WithOutFileSystem(IFileSystem fileSystem)
+		{
+			_fileSystem = fileSystem;
+		}
+
+		public void SomeMethod()
+		{
+			const string filePath = "C:\\temp.txt";
+
+			File.Delete(filePath);
+		}
+	}
+}
+```
+
+## Code with Fix
+
+``` csharp
+using System.IO.Abstractions;
+
+namespace SomeNameSpace
+{
+	public class WithOutFileSystem
+	{
+		private readonly IFileSystem _fileSystem;
+
+		public WithOutFileSystem(IFileSystem fileSystem)
+		{
+			_fileSystem = fileSystem;
+		}
+
+		public void SomeMethod()
+		{
+			const string filePath = "C:\\temp.txt";
+
+			_fileSystem.File.Delete(filePath);
+		}
+	}
+}
+```
diff --git a/docs/IO0003.MD b/docs/IO0003.MD
@@ -0,0 +1,64 @@
+# IO0003. Replace Directory class with IFileSystem.Directory for improved testability
+
+| Topic    | Value
+| :--      | :--
+| Id       | IO0003
+| Severity | Warning
+| Enabled  | True
+| Category | System.IO.Abstractions
+
+## Description
+
+Replace Directory class with IFileSystem.Directory for improved testability
+
+## Code with Diagnostic
+
+``` csharp
+using System.IO.Abstractions;
+
+namespace SomeNameSpace
+{
+	public class WithOutFileSystem
+	{
+		private readonly IFileSystem _fileSystem;
+
+		public WithOutFileSystem(IFileSystem fileSystem)
+		{
+			_fileSystem = fileSystem;
+		}
+
+		public void SomeMethod()
+		{
+			const string filePath = "C:\\temp";
+
+			Directory.Exists(filePath);
+		}
+	}
+}
+```
+
+## Code with Fix
+
+``` csharp
+using System.IO.Abstractions;
+
+namespace SomeNameSpace
+{
+	public class WithOutFileSystem
+	{
+		private readonly IFileSystem _fileSystem;
+
+		public WithOutFileSystem(IFileSystem fileSystem)
+		{
+			_fileSystem = fileSystem;
+		}
+
+		public void SomeMethod()
+		{
+			const string filePath = "C:\\temp";
+
+			_fileSystem.Directory.Exists(filePath);
+		}
+	}
+}
+```
diff --git a/docs/IO0004.MD b/docs/IO0004.MD
diff --git a/docs/IO0005.MD b/docs/IO0005.MD
diff --git a/docs/IO0006.MD b/docs/IO0006.MD
diff --git a/docs/IO0007.MD b/docs/IO0007.MD

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,6 @@ public class DirectoryCodeFix : BaseInvokeCodeFix`
`10`	`10`	`{`
`11`	`11`	`protected override string DiagnosticId => Constants.Io0003;`
`12`	`12`
`13`		`- protected override string Title => "Use IFileSystem.Directory for improved testablity";`
	`13`	`+ protected override string Title => "Use IFileSystem.Directory for improved testability";`
`14`	`14`	`}`
`15`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ namespace System.IO.Abstractions.Analyzers.CodeFixes`
`14`	`14`	`[ExportCodeFixProvider(LanguageNames.CSharp, Name = nameof(DirectoryInfoCodeFix))]`
`15`	`15`	`public class DirectoryInfoCodeFix : CodeFixProvider`
`16`	`16`	`{`
`17`		`- private const string Title = "Use IDirectoryInfoFactory instead creation DirectoryInfo for improved testablity";`
	`17`	`+ private const string Title = "Use IDirectoryInfoFactory instead creation DirectoryInfo for improved testability";`
`18`	`18`
`19`	`19`	`public override ImmutableArray<string> FixableDiagnosticIds =>`
`20`	`20`	`ImmutableArray.Create(Constants.Io0007);`