Add exception resource strings, make some methods static, ignore newl…

…ine diffs in tests
dotnet · carlossanlop · Apr 28, 2025 · Feb 1, 2025 · Feb 1, 2025 · Feb 1, 2025
commit edc45a9763190be9cdcb30f806e214e9be0e86cc
diff --git a/src/Compatibility/ApiDiff/Microsoft.DotNet.ApiDiff.Tool/GenAPIDiffConfigurationBinder.cs b/src/Compatibility/ApiDiff/Microsoft.DotNet.ApiDiff.Tool/GenAPIDiffConfigurationBinder.cs
@@ -48,12 +48,12 @@ internal GenAPIDiffConfigurationBinder(Option<string> optionBeforeAssembliesFold
 
     protected override DiffConfiguration GetBoundValue(BindingContext bindingContext) =>
         new DiffConfiguration(
-            BeforeAssembliesFolderPath: bindingContext.ParseResult.GetValueForOption(_optionBeforeAssembliesFolderPath) ?? throw new NullReferenceException("Null before assemblies directory."),
+            BeforeAssembliesFolderPath: bindingContext.ParseResult.GetValueForOption(_optionBeforeAssembliesFolderPath) ?? throw new NullReferenceException(Resources.NullBeforeAssembliesDirectory),
             BeforeAssemblyReferencesFolderPath: bindingContext.ParseResult.GetValueForOption(_optionBeforeAssemblyReferencesFolderPath),
-            AfterAssembliesFolderPath: bindingContext.ParseResult.GetValueForOption(_optionAfterAssembliesFolderPath) ?? throw new NullReferenceException("Null after assemblies directory."),
+            AfterAssembliesFolderPath: bindingContext.ParseResult.GetValueForOption(_optionAfterAssembliesFolderPath) ?? throw new NullReferenceException(Resources.NullAfterAssembliesDirectory),
             AfterAssemblyReferencesFolderPath: bindingContext.ParseResult.GetValueForOption(_optionAfterAssemblyReferencesFolderPath),
-            OutputFolderPath: bindingContext.ParseResult.GetValueForOption(_optionOutputFolderPath) ?? throw new NullReferenceException("Null output directory."),
-            TableOfContentsTitle: bindingContext.ParseResult.GetValueForOption(_optionTableOfContentsTitle) ?? throw new NullReferenceException("Null table of contents title."),
+            OutputFolderPath: bindingContext.ParseResult.GetValueForOption(_optionOutputFolderPath) ?? throw new NullReferenceException(Resources.NullOutputDirectory),
+            TableOfContentsTitle: bindingContext.ParseResult.GetValueForOption(_optionTableOfContentsTitle) ?? throw new NullReferenceException(Resources.NullTableOfContentsTitle),
             AttributesToExclude: bindingContext.ParseResult.GetValueForOption(_optionAttributesToExclude),
             ApisToExclude: bindingContext.ParseResult.GetValueForOption(_optionApisToExclude),
             AddPartialModifier: bindingContext.ParseResult.GetValueForOption(_optionAddPartialModifier),

@@ -121,7 +121,7 @@ public void Run()
         }
     }
 
-    private string GetFinalAssemblyDiff(string assemblyName, string diffText)
+    private static string GetFinalAssemblyDiff(string assemblyName, string diffText)
     {
         StringBuilder sbAssembly = new();
         sbAssembly.AppendLine($"# {assemblyName}");
@@ -189,7 +189,7 @@ private string GetFinalAssemblyDiff(string assemblyName, string diffText)
         return null;
     }
 
-    private Dictionary<string, MemberDeclarationSyntax> CollectChildrenNodes(SyntaxNode parentNode, SemanticModel model)
+    private static Dictionary<string, MemberDeclarationSyntax> CollectChildrenNodes(SyntaxNode parentNode, SemanticModel model)
     {
         Dictionary<string, MemberDeclarationSyntax> dictionary = new();
 
@@ -276,7 +276,7 @@ private Dictionary<string, MemberDeclarationSyntax> CollectChildrenNodes(SyntaxN
                 }
                 break;
             default:
-                throw new NotSupportedException($"Unexpected change type for node {nodeName}: {changeType}");
+                throw new NotSupportedException(string.Format(Resources.UnexpectedChangeTypeForNode, nodeName, changeType));
         }
 
         return sb.Length > 0 ? sb.ToString() : null;
@@ -299,11 +299,11 @@ private Dictionary<string, MemberDeclarationSyntax> CollectChildrenNodes(SyntaxN
             return namespaceNode.WithAttributeLists(_emptyAttributeList).WithLeadingTrivia(node.GetLeadingTrivia());
         }
 
-        throw new InvalidOperationException($"Unsupported node for removing attributes.");
+        throw new InvalidOperationException(Resources.UnsupportedNodeForRemovingAttributes);
     }
 
     // Returns a non-null string if any attribute was changed (added, deleted or modified). Returns null if all attributes were the same before and after.
-    private string? VisitAttributes(MemberDeclarationSyntax? beforeNode, MemberDeclarationSyntax? afterNode)
+    private static string? VisitAttributes(MemberDeclarationSyntax? beforeNode, MemberDeclarationSyntax? afterNode)
     {
         Dictionary<string, AttributeSyntax>? beforeAttributeNodes = beforeNode != null ? CollectAttributeNodes(beforeNode) : null;
         Dictionary<string, AttributeSyntax>? afterAttributeNodes = afterNode != null ? CollectAttributeNodes(afterNode) : null;
@@ -351,15 +351,15 @@ private Dictionary<string, MemberDeclarationSyntax> CollectChildrenNodes(SyntaxN
     private (SyntaxNode rootNode, SemanticModel model) GetAssemblyRootNodeAndModel(IAssemblySymbolLoader loader, IAssemblySymbol assemblySymbol)
     {
         CSharpAssemblyDocumentGenerator docGenerator = new(_log,
-                                                             loader,
-                                                             _symbolFilter,
-                                                             _attributeSymbolFilter,
-                                                             exceptionMessage: null,
-                                                             includeAssemblyAttributes: false,
-                                                             loader.MetadataReferences,
-                                                             diagnosticOptions: _diagnosticOptions,
-                                                             addPartialModifier: _addPartialModifier,
-                                                             hideImplicitDefaultConstructors: _hideImplicitDefaultConstructors);
+                                                           loader,
+                                                           _symbolFilter,
+                                                           _attributeSymbolFilter,
+                                                           exceptionMessage: null,
+                                                           includeAssemblyAttributes: false,
+                                                           loader.MetadataReferences,
+                                                           diagnosticOptions: _diagnosticOptions,
+                                                           addPartialModifier: _addPartialModifier,
+                                                           hideImplicitDefaultConstructors: _hideImplicitDefaultConstructors);
 
         // This is a workaround to get the root node and semantic model for a rewritten assembly root node.
         Document oldDocument = docGenerator.GetDocumentForAssembly(assemblySymbol);
@@ -409,7 +409,7 @@ private string GetCodeWrappedByParent(string childrenText, SyntaxNode parentNode
         return sb.ToString();
     }
 
-    private SyntaxNode GetChildlessNode(SyntaxNode node)
+    private static SyntaxNode GetChildlessNode(SyntaxNode node)
     {
         SyntaxNode childlessNode = node switch
         {
@@ -472,7 +472,7 @@ private string GetCodeOfNodeClosing(SyntaxNode childlessNode)
                         .WithLeadingTrivia(nsDecl.CloseBraceToken.LeadingTrivia.AddRange(_twoSpacesTrivia))
                         .WithTrailingTrivia(SyntaxFactory.CarriageReturnLineFeed),
 
-            _ => throw new InvalidOperationException("Unexpected node type.")
+            _ => throw new InvalidOperationException(Resources.UnexpectedNodeType)
         };
 
         StringBuilder sb = new();
@@ -507,7 +507,7 @@ private static string GetDocId(SyntaxNode node, SemanticModel model)
             }
         }
 
-        throw new NullReferenceException($"Could not get the DocID of the node: {node}");
+        throw new NullReferenceException(string.Format(Resources.CouldNotGetDocIdForNode, node));
     }
 
     private static string? GenerateAddedDiff(SyntaxNode afterNode) =>
@@ -540,14 +540,8 @@ private static string GetDocId(SyntaxNode node, SemanticModel model)
                 default:
                     break;
             }
-            ;
         }
 
-        if (sb.Length == 0)
-        {
-            return null;
-        }
-
-        return sb.ToString();
+        return sb.Length == 0 ? null : sb.ToString();
     }
 }
diff --git a/src/Compatibility/ApiDiff/Microsoft.DotNet.ApiDiff/Resources.resx b/src/Compatibility/ApiDiff/Microsoft.DotNet.ApiDiff/Resources.resx
@@ -1,17 +1,17 @@
 <?xml version="1.0" encoding="utf-8"?>
 <root>
-  <!-- 
-    Microsoft ResX Schema 
-    
+  <!--
+    Microsoft ResX Schema
+
     Version 2.0
-    
-    The primary goals of this format is to allow a simple XML format 
-    that is mostly human readable. The generation and parsing of the 
-    various data types are done through the TypeConverter classes 
+
+    The primary goals of this format is to allow a simple XML format
+    that is mostly human readable. The generation and parsing of the
+    various data types are done through the TypeConverter classes
     associated with the data types.
-    
+
     Example:
-    
+
     ... ado.net/XML headers & schema ...
     <resheader name="resmimetype">text/microsoft-resx</resheader>
     <resheader name="version">2.0</resheader>
@@ -26,36 +26,36 @@
         <value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
         <comment>This is a comment</comment>
     </data>
-                
-    There are any number of "resheader" rows that contain simple 
+
+    There are any number of "resheader" rows that contain simple
     name/value pairs.
-    
-    Each data row contains a name, and value. The row also contains a 
-    type or mimetype. Type corresponds to a .NET class that support 
-    text/value conversion through the TypeConverter architecture. 
-    Classes that don't support this are serialized and stored with the 
+
+    Each data row contains a name, and value. The row also contains a
+    type or mimetype. Type corresponds to a .NET class that support
+    text/value conversion through the TypeConverter architecture.
+    Classes that don't support this are serialized and stored with the
     mimetype set.
-    
-    The mimetype is used for serialized objects, and tells the 
-    ResXResourceReader how to depersist the object. This is currently not 
+
+    The mimetype is used for serialized objects, and tells the
+    ResXResourceReader how to depersist the object. This is currently not
     extensible. For a given mimetype the value must be set accordingly:
-    
-    Note - application/x-microsoft.net.object.binary.base64 is the format 
-    that the ResXResourceWriter will generate, however the reader can 
+
+    Note - application/x-microsoft.net.object.binary.base64 is the format
+    that the ResXResourceWriter will generate, however the reader can
     read any of the formats listed below.
-    
+
     mimetype: application/x-microsoft.net.object.binary.base64
-    value   : The object must be serialized with 
+    value   : The object must be serialized with
             : System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
             : and then encoded with base64 encoding.
-    
+
     mimetype: application/x-microsoft.net.object.soap.base64
-    value   : The object must be serialized with 
+    value   : The object must be serialized with
             : System.Runtime.Serialization.Formatters.Soap.SoapFormatter
             : and then encoded with base64 encoding.
 
     mimetype: application/x-microsoft.net.object.bytearray.base64
-    value   : The object must be serialized into a byte array 
+    value   : The object must be serialized into a byte array
             : using a System.ComponentModel.TypeConverter
             : and then encoded with base64 encoding.
     -->
@@ -120,7 +120,31 @@
   <data name="AddMemberThrowsException" xml:space="preserve">
     <value>Adding member '{0}' to the named type '{1}' failed with exception '{2}'.</value>
   </data>
+  <data name="CouldNotGetDocIdForNode" xml:space="preserve">
+    <value>Could not get the DocID for node: {0}</value>
+  </data>
+  <data name="NullAfterAssembliesDirectory" xml:space="preserve">
+    <value>Null after assemblies directory.</value>
+  </data>
+  <data name="NullBeforeAssembliesDirectory" xml:space="preserve">
+    <value>Null before assemblies directory.</value>
+  </data>
+  <data name="NullOutputDirectory" xml:space="preserve">
+    <value>Null output directory.</value>
+  </data>
+  <data name="NullTableOfContentsTitle" xml:space="preserve">
+    <value>Null table of contents title.</value>
+  </data>
   <data name="ResolveTypeForwardFailed" xml:space="preserve">
     <value>Could not resolve type '{0}' in containing assembly '{1}' via type forward. Make sure that the assembly is provided as a reference and contains the type.</value>
   </data>
-</root>
+  <data name="UnexpectedChangeTypeForNode" xml:space="preserve">
+    <value>Unexpected change type for node {0}: {1}</value>
+  </data>
+  <data name="UnsupportedNodeForRemovingAttributes" xml:space="preserve">
+    <value>Unsupported node for removing attributes.</value>
+  </data>
+  <data name="UnexpectedNodeType" xml:space="preserve">
+    <value>Unexpected node type.</value>
+  </data>
+</root>
diff --git a/src/Compatibility/ApiDiff/Microsoft.DotNet.ApiDiff/xlf/Resources.cs.xlf b/src/Compatibility/ApiDiff/Microsoft.DotNet.ApiDiff/xlf/Resources.cs.xlf
diff --git a/src/Compatibility/ApiDiff/Microsoft.DotNet.ApiDiff/xlf/Resources.de.xlf b/src/Compatibility/ApiDiff/Microsoft.DotNet.ApiDiff/xlf/Resources.de.xlf