Allow ignoring properties using TypeContractorIgnore

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Simplified response for generated API clients using the React template (#203)
 - Add default maps for unsigned numbers (#180)
+- Apply `TypeContractorIgnore` to properties
 
 ### Fixed
 

README.md

@@ -273,6 +273,8 @@ Available annotations:
   If you have a controller that doesn't need a client
   generated, you can annotate that controller using `TypeContractorIgnore`
   and it will be automatically skipped.
+
+  Also works on properties that shouldn't be included in generated DTOs.
 * `TypeContractorName`:
   If you have a badly named controller that you can't rename,
   you want something custom, or just don't like the default naming

TypeContractor.Annotations/TypeContractorIgnoreAttribute.cs

@@ -3,11 +3,11 @@
 namespace TypeContractor.Annotations
 {
 	/// <summary>
-	/// Tells TypeContractor to ignore the given controller when generating
-	/// automatic API clients. For example a controller that serves static
-	/// assets for the HTML templates.
+	/// Tells TypeContractor to ignore the target when generating TypeScript.
+	/// For example a controller that serves static assets for HTML templates.
+	/// Can also be used for properties that don't need to be exposed.
 	/// </summary>
-	[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = true)]
+	[AttributeUsage(AttributeTargets.Class | AttributeTargets.Field | AttributeTargets.Property, AllowMultiple = false, Inherited = true)]
 	public sealed class TypeContractorIgnoreAttribute : Attribute
 	{
 	}

TypeContractor.Tests/TypeScript/TypeScriptConverterTests.cs

@@ -1,5 +1,6 @@
 using System.Reflection;
 using System.Runtime.InteropServices;
+using TypeContractor.Annotations;
 using TypeContractor.TypeScript;
 
 namespace TypeContractor.Tests.TypeScript;
@@ -416,6 +417,18 @@ public void Handles_Arrays()
 		list.IsArray.Should().BeTrue();
 	}
 
+	[Fact]
+	public void Ignores_Properties_With_IgnoreAttribute()
+	{
+		var result = Sut.Convert(typeof(ResponseWithIgnoredProperties));
+
+		result.Should().NotBeNull();
+		result.Properties.Should()
+			.NotBeNull()
+			.And.ContainSingle()
+			.And.Contain(x => x.DestinationName == "dontIgnoreMeBro");
+	}
+
 #pragma warning disable CS8618 // Non-nullable field must contain a non-null value when exiting constructor. Consider declaring as nullable.
 	private record TopLevelRecord(string Name, SecondStoryRecord? SecondStoryRecord);
 	private record SecondStoryRecord(string Description, SomeOtherDeeplyNestedRecord? SomeOtherDeeplyNestedRecord);
@@ -559,6 +572,13 @@ private class ResponseWithArrayDto
 		public DateOnlyResponse[] DateOnlyResponses { get; set; }
 	}
 
+	private class ResponseWithIgnoredProperties
+	{
+		public string DontIgnoreMeBro { get; set; }
+		[TypeContractorIgnore]
+		public string FeelFreeToIgnoreMe { get; set; }
+	}
+
 #pragma warning restore CS8618 // Non-nullable field must contain a non-null value when exiting constructor. Consider declaring as nullable.
 
 	private MetadataLoadContext BuildMetadataLoadContext()

TypeContractor.Tool/ConsoleLogger.cs

@@ -4,6 +4,7 @@ namespace TypeContractor.Tool;
 
 public enum LogLevel
 {
+	Trace,
 	Debug,
 	Info,
 	Warning,
@@ -42,4 +43,10 @@ public void LogDebug(string message)
 		if (logLevel <= LogLevel.Debug)
 			Console.WriteLine($"[ DBG] {message}");
 	}
+
+	public void LogTrace(string message)
+	{
+		if (logLevel <= LogLevel.Trace)
+			Console.WriteLine($"[TRC] {message}");
+	}
 }

TypeContractor/Logger/ILog.cs

@@ -2,6 +2,7 @@ namespace TypeContractor.Logger;
 
 public interface ILog
 {
+	void LogTrace(string message);
 	void LogDebug(string message);
 	void LogError(Exception exception, string message);
 	void LogError(string message);

TypeContractor/Logger/NullLogger.cs

@@ -2,6 +2,10 @@ namespace TypeContractor.Logger;
 
 public class NullLogger : ILog
 {
+	public void LogTrace(string message)
+	{
+	}
+
 	public void LogDebug(string message)
 	{
 	}

TypeContractor/TypeScript/TypeScriptConverter.cs

@@ -1,5 +1,7 @@
 using System.Reflection;
+using TypeContractor.Annotations;
 using TypeContractor.Helpers;
+using TypeContractor.Logger;
 using TypeContractor.Output;
 
 namespace TypeContractor.TypeScript;
@@ -62,6 +64,12 @@ private List<OutputProperty> GetProperties(Type type)
 		// Evaluate type of property
 		foreach (var property in properties)
 		{
+			if (property.HasCustomAttribute(typeof(TypeContractorIgnoreAttribute).FullName!))
+			{
+				Log.Instance.LogTrace($"Property {type.FullName ?? type.Name}.{property.Name} is ignored by attribute");
+				continue;
+			}
+
 			// Need to have a getter
 			if (!property.CanRead) continue;