Merge pull request #79 from sveinungf/dev/diagnostics

Source generator - Improved diagnostics
sveinungf · Oct 5, 2024 · 8850c25 · 8850c25
2 parents 6eb25fe + fe1b130
commit 8850c25
Show file tree

Hide file tree

Showing 148 changed files with 2,314 additions and 5,083 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -276,6 +276,21 @@ dotnet_diagnostic.S927.severity = none
 # S2094: Classes should not be empty
 dotnet_diagnostic.S2094.severity = none
 
+[{*SnapshotTest}/**.cs]
+# S2699: Tests should include assertions (false positive for analyzer tests)
+dotnet_diagnostic.S2699.severity = none
+
+###############################
+# SpreadCheetah Options       #
+###############################
+[{ClassWithNoPropertiesContext.cs,NoPropertiesContext.cs}]
+# SPCH1001: Type has no properties with public getters
+dotnet_diagnostic.SPCH1001.severity = none
+
+[{CustomTypeContext.cs}]
+# SPCH1002: Type with unsupported property type
+dotnet_diagnostic.SPCH1002.severity = none
+
 ###############################
 # Threading.Analyzers Options #
 ###############################

diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -23,6 +23,7 @@
     <PackageVersion Include="Microsoft.Bcl.AsyncInterfaces" Version="1.1.1" />
     <PackageVersion Include="Microsoft.Bcl.HashCode" Version="1.1.1" />
     <PackageVersion Include="Microsoft.CodeAnalysis.Analyzers" Version="3.3.4" />
+    <PackageVersion Include="Microsoft.CodeAnalysis.CSharp.Analyzer.Testing" Version="1.1.2" />
     <PackageVersion Include="Microsoft.CodeAnalysis.CSharp.Workspaces" Version="4.9.2" />
     <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
     <PackageVersion Include="Polyfill" Version="6.2.0" />

diff --git a/SpreadCheetah.SourceGenerator.CSharp8Test/Models/ClassWithNoPropertiesContext.cs b/SpreadCheetah.SourceGenerator.CSharp8Test/Models/ClassWithNoPropertiesContext.cs
@@ -3,7 +3,6 @@
 namespace SpreadCheetah.SourceGenerator.CSharp8Test.Models
 {
     [WorksheetRow(typeof(ClassWithNoProperties))]
-    [WorksheetRowGenerationOptions(SuppressWarnings = true)]
     public partial class ClassWithNoPropertiesContext : WorksheetRowContext
     {
     }

diff --git a/SpreadCheetah.SourceGenerator.SnapshotTest/Helpers/AnalyzerTest.cs b/SpreadCheetah.SourceGenerator.SnapshotTest/Helpers/AnalyzerTest.cs
@@ -0,0 +1,25 @@
+using Microsoft.CodeAnalysis;
+using Microsoft.CodeAnalysis.CSharp.Testing;
+using Microsoft.CodeAnalysis.Testing;
+using SpreadCheetah.SourceGeneration;
+using SpreadCheetah.SourceGenerators;
+
+namespace SpreadCheetah.SourceGenerator.SnapshotTest.Helpers;
+
+internal static class AnalyzerTest
+{
+    public static CSharpAnalyzerTest<WorksheetRowAnalyzer, DefaultVerifier> CreateContext()
+    {
+        return new CSharpAnalyzerTest<WorksheetRowAnalyzer, DefaultVerifier>
+        {
+            TestState =
+            {
+                ReferenceAssemblies = ReferenceAssemblies.Net.Net80,
+                AdditionalReferences =
+                {
+                    MetadataReference.CreateFromFile(typeof(WorksheetRowAttribute).Assembly.Location)
+                }
+            }
+        };
+    }
+}
diff --git a/SpreadCheetah.SourceGenerator.SnapshotTest/Helpers/TestHelper.cs b/SpreadCheetah.SourceGenerator.SnapshotTest/Helpers/TestHelper.cs
@@ -28,7 +28,6 @@ private static PortableExecutableReference[] GetAssemblyReferences()
 
     public static SettingsTask CompileAndVerify<T>(string source,
         bool replaceEscapedLineEndings = false,
-        bool onlyDiagnostics = false,
         params object?[] parameters) where T : IIncrementalGenerator, new()
     {
         var syntaxTree = CSharpSyntaxTree.ParseText(source);
@@ -50,9 +49,6 @@ public static SettingsTask CompileAndVerify<T>(string source,
 
         var task = Verify(target, settings);
 
-        if (onlyDiagnostics)
-            task = task.IgnoreGeneratedResult(x => x.SourceText.ToString().Contains("public WorksheetRowTypeInfo<", StringComparison.Ordinal));
-
         return parameters.Length > 0
             ? task.UseParameters(parameters)
             : task;

diff --git a/SpreadCheetah.SourceGenerator.SnapshotTest/Models/.editorconfig b/SpreadCheetah.SourceGenerator.SnapshotTest/Models/.editorconfig
diff --git a/SpreadCheetah.SourceGenerator.SnapshotTest/Models/ClassWithAllSupportedTypes.cs b/SpreadCheetah.SourceGenerator.SnapshotTest/Models/ClassWithAllSupportedTypes.cs
diff --git a/SpreadCheetah.SourceGenerator.SnapshotTest/Models/ClassWithInheritance.cs b/SpreadCheetah.SourceGenerator.SnapshotTest/Models/ClassWithInheritance.cs
diff --git a/SpreadCheetah.SourceGenerator.SnapshotTest/Models/ClassWithMultipleProperties.cs b/SpreadCheetah.SourceGenerator.SnapshotTest/Models/ClassWithMultipleProperties.cs
diff --git a/SpreadCheetah.SourceGenerator.SnapshotTest/Models/ClassWithNoProperties.cs b/SpreadCheetah.SourceGenerator.SnapshotTest/Models/ClassWithNoProperties.cs
diff --git a/SpreadCheetah.SourceGenerator.SnapshotTest/Models/ClassWithSingleProperty.cs b/SpreadCheetah.SourceGenerator.SnapshotTest/Models/ClassWithSingleProperty.cs
diff --git a/SpreadCheetah.SourceGenerator.SnapshotTest/Models/ClassWithSinglePropertyAlternative.cs b/SpreadCheetah.SourceGenerator.SnapshotTest/Models/ClassWithSinglePropertyAlternative.cs
diff --git a/SpreadCheetah.SourceGenerator.SnapshotTest/Models/ClassWithUnsupportedProperty.cs b/SpreadCheetah.SourceGenerator.SnapshotTest/Models/ClassWithUnsupportedProperty.cs
diff --git a/...SourceGenerator.SnapshotTest/Models/ColumnHeader/ClassWithColumnHeaderForAllProperties.cs b/...SourceGenerator.SnapshotTest/Models/ColumnHeader/ClassWithColumnHeaderForAllProperties.cs
diff --git a/...urceGenerator.SnapshotTest/Models/ColumnHeader/ClassWithPropertyReferenceColumnHeaders.cs b/...urceGenerator.SnapshotTest/Models/ColumnHeader/ClassWithPropertyReferenceColumnHeaders.cs
diff --git a/...ourceGenerator.SnapshotTest/Models/ColumnHeader/ClassWithSpecialCharacterColumnHeaders.cs b/...ourceGenerator.SnapshotTest/Models/ColumnHeader/ClassWithSpecialCharacterColumnHeaders.cs
diff --git a/...ourceGenerator.SnapshotTest/Models/ColumnOrdering/ClassWithColumnOrderForAllProperties.cs b/...ourceGenerator.SnapshotTest/Models/ColumnOrdering/ClassWithColumnOrderForAllProperties.cs
diff --git a/...urceGenerator.SnapshotTest/Models/ColumnOrdering/ClassWithColumnOrderForSomeProperties.cs b/...urceGenerator.SnapshotTest/Models/ColumnOrdering/ClassWithColumnOrderForSomeProperties.cs
diff --git a/...SnapshotTest/Models/InheritColumns/RecordClass2LevelOfInheritanceInheritedColumnsFirst.cs b/...SnapshotTest/Models/InheritColumns/RecordClass2LevelOfInheritanceInheritedColumnsFirst.cs
diff --git a/...eritColumns/RecordClass2LevelOfInheritanceInheritedColumnsFirstParentIgnoreInheritance.cs b/...eritColumns/RecordClass2LevelOfInheritanceInheritedColumnsFirstParentIgnoreInheritance.cs
diff --git a/...ritColumns/RecordClass2LevelOfInheritanceInheritedColumnsFirstParentInheritColumnsLast.cs b/...ritColumns/RecordClass2LevelOfInheritanceInheritedColumnsFirstParentInheritColumnsLast.cs
diff --git a/....SnapshotTest/Models/InheritColumns/RecordClass2LevelOfInheritanceInheritedColumnsLast.cs b/....SnapshotTest/Models/InheritColumns/RecordClass2LevelOfInheritanceInheritedColumnsLast.cs
diff --git a/...heritColumns/RecordClass2LevelOfInheritanceInheritedColumnsLastParentIgnoreInheritance.cs b/...heritColumns/RecordClass2LevelOfInheritanceInheritedColumnsLastParentIgnoreInheritance.cs
diff --git a/...ritColumns/RecordClass2LevelOfInheritanceInheritedColumnsLastParentInheritColumnsFirst.cs b/...ritColumns/RecordClass2LevelOfInheritanceInheritedColumnsLastParentInheritColumnsFirst.cs
diff --git a/...ah.SourceGenerator.SnapshotTest/Models/InheritColumns/RecordClassWithIgnoreInheritance.cs b/...ah.SourceGenerator.SnapshotTest/Models/InheritColumns/RecordClassWithIgnoreInheritance.cs
diff --git a/...ourceGenerator.SnapshotTest/Models/InheritColumns/RecordClassWithInheritedColumnsFirst.cs b/...ourceGenerator.SnapshotTest/Models/InheritColumns/RecordClassWithInheritedColumnsFirst.cs
diff --git a/...SourceGenerator.SnapshotTest/Models/InheritColumns/RecordClassWithInheritedColumnsLast.cs b/...SourceGenerator.SnapshotTest/Models/InheritColumns/RecordClassWithInheritedColumnsLast.cs
diff --git a/SpreadCheetah.SourceGenerator.SnapshotTest/Models/ReadOnlyRecordStructWithSingleProperty.cs b/SpreadCheetah.SourceGenerator.SnapshotTest/Models/ReadOnlyRecordStructWithSingleProperty.cs
diff --git a/SpreadCheetah.SourceGenerator.SnapshotTest/Models/ReadOnlyStructWithSingleProperty.cs b/SpreadCheetah.SourceGenerator.SnapshotTest/Models/ReadOnlyStructWithSingleProperty.cs