Introduce AnalyzerStrings

dotnet · Nov 25, 2021 · c5f0ae7 · c5f0ae7
1 parent 25aa05e
commit c5f0ae7
Show file tree

Hide file tree

Showing 6 changed files with 117 additions and 21 deletions.
diff --git a/src/EFCore.Analyzers/EFCore.Analyzers.csproj b/src/EFCore.Analyzers/EFCore.Analyzers.csproj
@@ -19,6 +19,11 @@
 
   <ItemGroup>
     <Compile Include="..\Shared\CodeAnnotations.cs" />
+    <Compile Update="Properties\AnalyzerStrings.Designer.cs">
+      <DesignTime>True</DesignTime>
+      <AutoGen>True</AutoGen>
+      <DependentUpon>AnalyzerStrings.resx</DependentUpon>
+    </Compile>
   </ItemGroup>
 
   <ItemGroup>
@@ -45,4 +50,12 @@
     <AdditionalFiles Include="AnalyzerReleases.Unshipped.md" />
   </ItemGroup>
 
+  <ItemGroup>
+    <EmbeddedResource Update="Properties\AnalyzerStrings.resx">
+      <Generator>PublicResXFileCodeGenerator</Generator>
+      <LastGenOutput>AnalyzerStrings.Designer.cs</LastGenOutput>
+      <CustomToolNamespace>Microsoft.EntityFrameworkCore</CustomToolNamespace>
+    </EmbeddedResource>
+  </ItemGroup>
+
 </Project>
diff --git a/src/EFCore.Analyzers/InternalUsageDiagnosticAnalyzer.cs b/src/EFCore.Analyzers/InternalUsageDiagnosticAnalyzer.cs
@@ -13,23 +13,14 @@ namespace Microsoft.EntityFrameworkCore;
 public sealed class InternalUsageDiagnosticAnalyzer : DiagnosticAnalyzer
 {
     public const string Id = "EF1001";
-
-    public const string MessageFormat
-        = "{0} is an internal API that supports the Entity Framework Core infrastructure and "
-        + "not subject to the same compatibility standards as public APIs. "
-        + "It may be changed or removed without notice in any release.";
-
-    private const string DefaultTitle = "Internal EF Core API usage.";
-    private const string Category = "Usage";
-
     private static readonly int EFLen = "EntityFrameworkCore".Length;
 
     private static readonly DiagnosticDescriptor _descriptor
         = new(
             Id,
-            title: DefaultTitle,
-            messageFormat: MessageFormat,
-            category: Category,
+            title: AnalyzerStrings.InternalUsageTitle,
+            messageFormat: AnalyzerStrings.InternalUsageMessageFormat,
+            category: "Usage",
             defaultSeverity: DiagnosticSeverity.Warning,
             isEnabledByDefault: true);
 

diff --git a/src/EFCore.Analyzers/Properties/AnalyzerStrings.Designer.cs b/src/EFCore.Analyzers/Properties/AnalyzerStrings.Designer.cs
diff --git a/src/EFCore.Analyzers/Properties/AnalyzerStrings.resx b/src/EFCore.Analyzers/Properties/AnalyzerStrings.resx
@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<root>
+  <xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
+    <xsd:element name="root" msdata:IsDataSet="true">
+
+    </xsd:element>
+  </xsd:schema>
+  <resheader name="resmimetype">
+    <value>text/microsoft-resx</value>
+  </resheader>
+  <resheader name="version">
+    <value>1.3</value>
+  </resheader>
+  <resheader name="reader">
+    <value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
+  </resheader>
+  <resheader name="writer">
+    <value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
+  </resheader>
+  <data name="UninitializedDbSetWarningSuppressionJustification" xml:space="preserve">
+    <value>DbSet properties on DbContext subclasses are automatically populated by the DbContext constructor.</value>
+  </data>
+  <data name="InternalUsageMessageFormat" xml:space="preserve">
+    <value>{0} is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release.</value>
+  </data>
+  <data name="InternalUsageTitle" xml:space="preserve">
+    <value>Internal EF Core API usage.</value>
+  </data>
+</root>
diff --git a/src/EFCore.Analyzers/UninitializedDbSetDiagnosticSuppressor.cs b/src/EFCore.Analyzers/UninitializedDbSetDiagnosticSuppressor.cs
@@ -14,7 +14,7 @@ public sealed class UninitializedDbSetDiagnosticSuppressor : DiagnosticSuppresso
     private static readonly SuppressionDescriptor _suppressUninitializedDbSetRule = new(
         id: "SPR1001",
         suppressedDiagnosticId: "CS8618",
-        justification: "DbSet properties on DbContext subclasses are automatically populated by the DbContext constructor");
+        justification: AnalyzerStrings.UninitializedDbSetWarningSuppressionJustification);
 
     /// <inheritdoc />
     public override ImmutableArray<SuppressionDescriptor> SupportedSuppressions { get; }

diff --git a/test/EFCore.Analyzers.Tests/InternalUsageDiagnosticAnalyzerTest.cs b/test/EFCore.Analyzers.Tests/InternalUsageDiagnosticAnalyzerTest.cs
@@ -40,7 +40,7 @@ class MyClass : Microsoft.EntityFrameworkCore.Storage.Internal.RawRelationalPara
                 Assert.Equal(DiagnosticSeverity.Warning, diagnostic.Severity);
                 Assert.Equal(
                     string.Format(
-                        InternalUsageDiagnosticAnalyzer.MessageFormat,
+                        AnalyzerStrings.InternalUsageMessageFormat,
                         "Microsoft.EntityFrameworkCore.Storage.Internal.RawRelationalParameter"),
                     diagnostic.GetMessage());
 
@@ -55,7 +55,7 @@ class MyClass : Microsoft.EntityFrameworkCore.Storage.Internal.RawRelationalPara
                 Assert.Equal(DiagnosticSeverity.Warning, diagnostic.Severity);
                 Assert.Equal(
                     string.Format(
-                        InternalUsageDiagnosticAnalyzer.MessageFormat,
+                        AnalyzerStrings.InternalUsageMessageFormat,
                         "Microsoft.EntityFrameworkCore.Storage.Internal.RawRelationalParameter"),
                     diagnostic.GetMessage());
 
@@ -201,9 +201,7 @@ private async Task Test(
 
         Assert.Equal(InternalUsageDiagnosticAnalyzer.Id, diagnostic.Id);
         Assert.Equal(DiagnosticSeverity.Warning, diagnostic.Severity);
-        Assert.Equal(
-            string.Format(InternalUsageDiagnosticAnalyzer.MessageFormat, expectedInternalApi),
-            diagnostic.GetMessage());
+        Assert.Equal(string.Format(AnalyzerStrings.InternalUsageMessageFormat, expectedInternalApi), diagnostic.GetMessage());
 
         var span = diagnostic.Location.SourceSpan;
         Assert.Equal(expectedDiagnosticSpan, fullSource[span.Start..span.End]);
@@ -219,9 +217,7 @@ private async Task TestFullSource(
 
         Assert.Equal(InternalUsageDiagnosticAnalyzer.Id, diagnostic.Id);
         Assert.Equal(DiagnosticSeverity.Warning, diagnostic.Severity);
-        Assert.Equal(
-            string.Format(InternalUsageDiagnosticAnalyzer.MessageFormat, expectedInternalApi),
-            diagnostic.GetMessage());
+        Assert.Equal(string.Format(AnalyzerStrings.InternalUsageMessageFormat, expectedInternalApi), diagnostic.GetMessage());
 
         var span = diagnostic.Location.SourceSpan;
         Assert.Equal(expectedDiagnosticSpan, fullSource[span.Start..span.End]);