Add warning when using RazorBlade in an ASP.NET project

ltrzesniewski · Apr 22, 2024 · 992f172 · 992f172
1 parent afd6234
commit 992f172
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/src/RazorBlade.Analyzers/Diagnostics.cs b/src/RazorBlade.Analyzers/Diagnostics.cs
@@ -1,4 +1,5 @@
-using Microsoft.AspNetCore.Razor.Language;
+using JetBrains.Annotations;
+using Microsoft.AspNetCore.Razor.Language;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.CSharp;
 
@@ -15,6 +16,7 @@ public enum Id
         ConditionalOnAsync = 3,
         EmbeddedLibraryUnsupportedCSharpVersion = 4,
         TagHelpersNotSupported = 5,
+        [UsedImplicitly] UsingWithRazorSdk = 6
     }
 
     private static DiagnosticDescriptor RoslynError(Id id, string title, string messageFormat)

diff --git a/src/RazorBlade/RazorBlade.targets b/src/RazorBlade/RazorBlade.targets
@@ -14,6 +14,11 @@
     <CompilerVisibleItemMetadata Include="AdditionalFiles" MetadataName="Namespace" />
   </ItemGroup>
 
+  <Target Name="RazorBladeBeforeCompile" BeforeTargets="BeforeCompile">
+    <Warning Condition="'$(UsingMicrosoftNETSdkRazor)' == 'true'" Code="RB0006"
+             Text="RazorBlade shouldn't be used in ASP.NET projects, as several Razor source generators would process the same .cshtml files by default. ASP.NET's generator is not compatible with the RazorBlade library." />
+  </Target>
+
   <Target Name="RazorBladePrepareAnalyzerInput" BeforeTargets="GenerateMSBuildEditorConfigFileCore">
     <PropertyGroup>
       <RazorBladeEmbeddedLibrary Condition="'$(RazorBladeEmbeddedLibrary)' == '' and @(PackageReference->WithMetadataValue('Identity', 'RazorBlade')->AnyHaveMetadataValue('PrivateAssets', 'all'))">True</RazorBladeEmbeddedLibrary>