merged avtc ignoreclassmembers attribute

codecentric · Aug 4, 2024 · 0c5cc77 · 0c5cc77
2 parents c859b21 + a602ecc
commit 0c5cc77
Show file tree

Hide file tree

Showing 7 changed files with 84 additions and 4 deletions.
diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json
@@ -3,10 +3,11 @@
   "isRoot": true,
   "tools": {
     "csharpier": {
-      "version": "0.27.1",
+      "version": "0.28.2",
       "commands": [
         "dotnet-csharpier"
-      ]
+      ],
+      "rollForward": false
     }
   }
 }
diff --git a/AutomaticInterface/AutomaticInterface/AutomaticInterface.csproj b/AutomaticInterface/AutomaticInterface/AutomaticInterface.csproj
@@ -25,7 +25,7 @@
         <PackageLicenseExpression>MIT</PackageLicenseExpression>
         <EnableNETAnalyzers>True</EnableNETAnalyzers>
         <AnalysisLevel>latest-Recommended</AnalysisLevel>
-        <Version>2.4.0</Version>
+        <Version>2.5.0</Version>
         <PackageReadmeFile>README.md</PackageReadmeFile>
         <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
         <NoWarn>1701;1702;NU5128</NoWarn>

diff --git a/AutomaticInterface/AutomaticInterface/AutomaticInterfaceGenerator.cs b/AutomaticInterface/AutomaticInterface/AutomaticInterfaceGenerator.cs
@@ -10,6 +10,7 @@ namespace AutomaticInterface;
 public class AutomaticInterfaceGenerator : IIncrementalGenerator
 {
     public const string DefaultAttributeName = "GenerateAutomaticInterface";
+    public const string IgnoreAutomaticInterfaceAttributeName = "IgnoreAutomaticInterface";
 
     public void Initialize(IncrementalGeneratorInitializationContext context)
     {

diff --git a/AutomaticInterface/AutomaticInterface/Builder.cs b/AutomaticInterface/AutomaticInterface/Builder.cs
@@ -78,6 +78,7 @@ InterfaceBuilder codeGenerator
             .Where(x => x.DeclaredAccessibility == Accessibility.Public)
             .Where(x => x.MethodKind == MethodKind.Ordinary)
             .Where(x => !x.IsStatic)
+            .Where(x => !HasIgnoreAttribute(x))
             .Where(x => x.ContainingType.Name != nameof(Object))
             .GroupBy(x => x.ToDisplayString(MethodSignatureDisplayFormat))
             .Select(g => g.First())
@@ -171,6 +172,7 @@ InterfaceBuilder codeGenerator
             .OfType<IEventSymbol>()
             .Where(x => x.DeclaredAccessibility == Accessibility.Public)
             .Where(x => !x.IsStatic)
+            .Where(x => !HasIgnoreAttribute(x))
             .ToList()
             .ForEach(evt =>
             {
@@ -244,6 +246,7 @@ InterfaceBuilder interfaceGenerator
             .Where(x => x.DeclaredAccessibility == Accessibility.Public)
             .Where(x => !x.IsStatic)
             .Where(x => !x.IsIndexer)
+            .Where(x => !HasIgnoreAttribute(x))
             .GroupBy(x => x.Name)
             .Select(g => g.First())
             .ToList()
@@ -269,6 +272,17 @@ InterfaceBuilder interfaceGenerator
             });
     }
 
+    private static bool HasIgnoreAttribute(ISymbol x)
+    {
+        return x.GetAttributes()
+            .Any(a =>
+                a.AttributeClass != null
+                && a.AttributeClass.Name.Contains(
+                    AutomaticInterfaceGenerator.IgnoreAutomaticInterfaceAttributeName
+                )
+            );
+    }
+
     private static string GetDocumentationForClass(CSharpSyntaxNode classSyntax)
     {
         if (!classSyntax.HasLeadingTrivia)
@@ -314,7 +328,7 @@ NamespaceDeclarationSyntax ndSyntax
                 );
         }
 
-        return [..allUsings.Select(x => x.ToString())];
+        return [.. allUsings.Select(x => x.ToString())];
     }
 
     private static string GetGeneric(TypeDeclarationSyntax classSyntax)

diff --git a/AutomaticInterface/AutomaticInterfaceAttribute/IgnoreAutomaticInterfaceAttribute.cs b/AutomaticInterface/AutomaticInterfaceAttribute/IgnoreAutomaticInterfaceAttribute.cs
@@ -0,0 +1,10 @@
+using System;
+
+namespace AutomaticInterfaceAttribute
+{
+    [AttributeUsage(AttributeTargets.Method | AttributeTargets.Property | AttributeTargets.Event)]
+    public class IgnoreAutomaticInterfaceAttribute : Attribute
+    {
+        public IgnoreAutomaticInterfaceAttribute() { }
+    }
+}
diff --git a/AutomaticInterface/Tests/GeneratorTests.cs b/AutomaticInterface/Tests/GeneratorTests.cs
@@ -713,6 +713,53 @@ public partial interface IDemoClass
         GenerateCode(code).Should().Be(expected);
     }
 
+    [Fact]
+    public void IgnoresMembersAttributedWithSkip()
+    {
+        const string code = """
+
+            using AutomaticInterfaceAttribute;
+            using System.IO;
+
+            namespace AutomaticInterfaceExample
+            {
+
+                [GenerateAutomaticInterface]
+                class DemoClass
+                {
+                    [IgnoreAutomaticInterface] public string Hello1(string x, int y, double z){return x;}
+                    [IgnoreAutomaticInterface] public string Hello2 { get; set; }
+                    [IgnoreAutomaticInterface] public event EventHandler Hello3;
+                }
+            }
+
+            """;
+
+        const string expected = """
+            //--------------------------------------------------------------------------------------------------
+            // <auto-generated>
+            //     This code was generated by a tool.
+            //
+            //     Changes to this file may cause incorrect behavior and will be lost if the code is regenerated.
+            // </auto-generated>
+            //--------------------------------------------------------------------------------------------------
+
+            using System.CodeDom.Compiler;
+            using AutomaticInterfaceAttribute;
+            using System.IO;
+
+            namespace AutomaticInterfaceExample
+            {
+                [GeneratedCode("AutomaticInterface", "")]
+                public partial interface IDemoClass
+                {
+                }
+            }
+
+            """;
+        GenerateCode(code).Should().Be(expected);
+    }
+
     [Fact]
     public void AddsDescriptionFromMethodToInterface()
     {

diff --git a/README.md b/README.md
@@ -34,6 +34,9 @@ namespace AutomaticInterfaceExample
 
         public string OnlyGet { get; } // included, get and set are copied to the interface when public
 
+        [IgnoreAutomaticInterface] 
+        public string OnlyGet { get; } // ignored with help of attribute
+
         /// <summary>
         /// Method Documentation will be copied
         /// </summary>
@@ -160,13 +163,17 @@ Please make sure that you run [CSharpier](https://csharpier.com/) on the code fo
 - roflmuffin for PRs
 - mohummedibrahim  for code and idea
 - simonmckenzie for PR
+- avtc for PR
 
 ## Run tests
 
 Should be simply a build and run Tests
 
 ## Changelog
 
+### 2.50.
+- Now can ignore class members with [IgnoreAutomaticInterface] attribute. Thanks avtc!
+
 ### 2.40.
 - Now prevents duplicates when overriding or shadowing methods (`new void DoSomething()`). Thanks simonmckenzie!