Emit a nullable directive in generated sync code (#947)

Brightspace · Feb 13, 2024 · 5c0e2d7 · 5c0e2d7
1 parent 785eb70
commit 5c0e2d7
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 0 deletions.
diff --git a/src/D2L.CodeStyle.Analyzers/Async/Generator/FileCollector.cs b/src/D2L.CodeStyle.Analyzers/Async/Generator/FileCollector.cs
@@ -82,6 +82,9 @@ public static FileCollector Create(
 		public string CollectSource() {
 			// TODO: Remove this and modify XML param elements in generator when changed/removed
 			m_out.AppendLine( "#pragma warning disable CS1572" );
+			// This allows us to copy+paste annotations but otherwise does not emit diagnostics
+			// otherwise we get "CS8669: The annotation for nullable reference types should only be used in code within a '#nullable' annotations context. Auto-generated code requires an explicit '#nullable' directive in source."
+			m_out.AppendLine( "#nullable annotations" );
 			// File-scoped usings:
 			m_out.Append( m_root.Usings.ToFullString() );
 

diff --git a/tests/D2L.CodeStyle.Analyzers.Test/Async/Generator/FileCollectorTests.cs b/tests/D2L.CodeStyle.Analyzers.Test/Async/Generator/FileCollectorTests.cs
@@ -24,6 +24,7 @@ void SomeMethod() {}
 		);
 
 		Assert.AreEqual( @"#pragma warning disable CS1572
+#nullable annotations
 ", collector.CollectSource() );
 	}
 
@@ -52,6 +53,7 @@ void MyMethodBefore() {
 		);
 
 		Assert.AreEqual( @"#pragma warning disable CS1572
+#nullable annotations
 
 using Foo;
 
@@ -89,6 +91,7 @@ void MyMethodBefore() {
 		);
 
 		Assert.AreEqual( @"#pragma warning disable CS1572
+#nullable annotations
 
 using Foo;
 
@@ -124,6 +127,7 @@ void MyMethodBefore() {{
 		);
 
 		Assert.AreEqual( @$"#pragma warning disable CS1572
+#nullable annotations
 
 partial {kind} X {{
 	any text
@@ -163,6 +167,7 @@ class Ignored2 {}
 		);
 
 		Assert.AreEqual( @"#pragma warning disable CS1572
+#nullable annotations
 
 using Foo;
 
@@ -244,6 +249,7 @@ void MyBeforeMethod4() { }
 		);
 
 		Assert.AreEqual( @"#pragma warning disable CS1572
+#nullable annotations
 
 using Foo;
 

diff --git a/tests/D2L.CodeStyle.Analyzers.Test/Async/Generator/SyncGeneratorTests.cs b/tests/D2L.CodeStyle.Analyzers.Test/Async/Generator/SyncGeneratorTests.cs
@@ -58,6 +58,7 @@ sealed class Bar {
 		);
 
 		AssertNewTrees( result, @"#pragma warning disable CS1572
+#nullable annotations
 
 using System;
 using System.IO;
@@ -91,6 +92,7 @@ partial interface IFoo {
 		);
 
 		AssertNewTrees( result, @"#pragma warning disable CS1572
+#nullable annotations
 
 using System;
 using System.Threading.Tasks;
@@ -140,6 +142,7 @@ public async Task BarAsync() {}
 		);
 
 		AssertNewTrees( result, @"#pragma warning disable CS1572
+#nullable annotations
 
 using System;
 using System.IO;
@@ -153,6 +156,7 @@ partial class Bar {
 	[Blocking]
 	public void Baz( StreamWriter x ) { return; }
 }", @"#pragma warning disable CS1572
+#nullable annotations
 
 using System;
 using System.IO;