docs: add mstest docs

Author: Meir017

README.md

@@ -31,6 +31,7 @@ dotnet add package FluentAssertions.Analyzers
 ## Docs
 
 - [FluentAssertions Analyzer Docs](docs/FluentAssertionsAnalyzer.md)
+- [MsTest Analyzer Docs](docs/MsTestAnalyzer.md)
 
 ## Getting Started
 

docs/MsTestAnalyzer.md

@@ -0,0 +1,38 @@
+<!--
+This is a generated file, please edit src\FluentAssertions.Analyzers.FluentAssertionAnalyzerDocsGenerator\DocsGenerator.cs to change the contents
+-->
+
+# MsTest Analyzer Docs
+
+- [BooleanAssertIsTrue](#scenario-booleanassertistrue) - `flag.Should().BeTrue();`
+
+
+## Scenarios
+
+### scenario: BooleanAssertIsTrue
+
+```cs
+// arrange
+var flag = true;
+
+// old assertion:
+Assert.IsTrue(flag);
+
+// new assertion:
+flag.Should().BeTrue();
+```
+
+#### Failure messages
+
+```cs
+// arrange
+var flag = false;
+
+// old assertion:
+Assert.IsTrue(flag); 	// fail message: Assert.IsTrue failed. 
+
+// new assertion:
+flag.Should().BeTrue(); 	// fail message: Assert.IsTrue failed. 
+```
+
+

src/FluentAssertions.Analyzers.FluentAssertionAnalyzerDocs/MsTestAnalyzerTests.cs

@@ -0,0 +1,39 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using FluentAssertions;
+using FluentAssertions.Execution;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+
+namespace FluentAssertions.Analyzers.FluentAssertionAnalyzerDocs;
+
+[TestClass]
+public class MsTestAnalyzerTests
+{
+    [TestMethod]
+    public void BooleanAssertIsTrue()
+    {
+        // arrange
+        var flag = true;
+
+        // old assertion:
+        Assert.IsTrue(flag);
+
+        // new assertion:
+        flag.Should().BeTrue();
+    }
+
+    [TestMethod, ExpectedException(typeof(AssertFailedException))]
+    public void BooleanAssertIsTrue_Failure()
+    {
+        using var scope = new AssertionScope();
+        // arrange
+        var flag = false;
+
+        // old assertion:
+        Assert.IsTrue(flag);
+
+        // new assertion:
+        flag.Should().BeTrue();
+    }
+}

src/FluentAssertions.Analyzers.FluentAssertionAnalyzerDocsGenerator/DocsGenerator.cs

@@ -22,27 +22,29 @@ public async Task Execute()
         var compilation = await FluentAssertionAnalyzerDocsUtils.GetFluentAssertionAnalyzerDocsCompilation();
         var compilationWithAnalyzers = compilation.WithAnalyzers(ImmutableArray.Create(analyzer));
 
-        var docs = new StringBuilder();
-        var toc = new StringBuilder();
-        var scenarios = new StringBuilder();
-
-        docs.AppendLine("<!--");
-        docs.AppendLine("This is a generated file, please edit src\\FluentAssertions.Analyzers.FluentAssertionAnalyzerDocsGenerator\\DocsGenerator.cs to change the contents");
-        docs.AppendLine("-->");
-        docs.AppendLine();
-
-        docs.AppendLine("# FluentAssertions Analyzer Docs");
-        docs.AppendLine();
-
-        scenarios.AppendLine("## Scenarios");
-        scenarios.AppendLine();
-
-        var testAssembly = typeof(FluentAssertions.Analyzers.FluentAssertionAnalyzerDocs.FluentAssertionsAnalyzerTests).Assembly;
+        var testAssembly = typeof(FluentAssertionAnalyzerDocs.FluentAssertionsAnalyzerTests).Assembly;
 
         foreach (var tree in compilationWithAnalyzers.Compilation.SyntaxTrees.Where(t => t.FilePath.EndsWith("Tests.cs")))
         {
             Console.WriteLine($"File: {Path.GetFileName(tree.FilePath)}");
 
+            var docsName = Path.GetFileNameWithoutExtension(tree.FilePath).Replace("Tests", ".md");
+
+            var docs = new StringBuilder();
+            var toc = new StringBuilder();
+            var scenarios = new StringBuilder();
+    
+            docs.AppendLine("<!--");
+            docs.AppendLine("This is a generated file, please edit src\\FluentAssertions.Analyzers.FluentAssertionAnalyzerDocsGenerator\\DocsGenerator.cs to change the contents");
+            docs.AppendLine("-->");
+            docs.AppendLine();
+
+            var subject = Path.GetFileNameWithoutExtension(tree.FilePath).Replace("AnalyzerTests", string.Empty);
+            docs.AppendLine($"# {subject} Analyzer Docs");
+            docs.AppendLine();
+    
+            scenarios.AppendLine("## Scenarios");
+            scenarios.AppendLine();
 
             var root = await tree.GetRootAsync();
             var classDef = root.DescendantNodes().OfType<ClassDeclarationSyntax>().First();
@@ -114,22 +116,22 @@ public async Task Execute()
                 Console.WriteLine($"source: {root.FindNode(diagnostic.Location.SourceSpan)}");
                 Console.WriteLine($"  diagnostic: {diagnostic}");
             }
-        }
 
-        docs.AppendLine(toc.ToString());
-        docs.AppendLine();
-        docs.AppendLine(scenarios.ToString());
+            docs.AppendLine(toc.ToString());
+            docs.AppendLine();
+            docs.AppendLine(scenarios.ToString());
 
-        var docsPath = Path.Combine(Environment.CurrentDirectory, "..", "..", "docs", "FluentAssertionsAnalyzer.md");
-        Directory.CreateDirectory(Path.GetDirectoryName(docsPath));
-        await File.WriteAllTextAsync(docsPath, docs.ToString());
+            var docsPath = Path.Combine(Environment.CurrentDirectory, "..", "..", "docs", docsName);
+            Directory.CreateDirectory(Path.GetDirectoryName(docsPath));
+            await File.WriteAllTextAsync(docsPath, docs.ToString());
+        }
     }
 
-    private string[] GetMethodExceptionMessageLines(object instnace, MethodInfo method)
+    private string[] GetMethodExceptionMessageLines(object instance, MethodInfo method)
     {
         try
         {
-            method.Invoke(instnace, null);
+            method.Invoke(instance, null);
         }
         catch (Exception ex) when (ex.InnerException is AssertFailedException exception)
         {