Rename "properties" to "metadata"

We refer to name/value pairs on items as "metadata" to differentiate them from project-level properties.

Author: drewnoakes

src/Microsoft.VisualStudio.ProjectSystem.Managed.VS/ProjectSystem/VS/PackageRestore/Snapshots/VsReferenceItem.cs

@@ -15,5 +15,5 @@ internal class VsReferenceItem(ReferenceItem referenceItem) : IVsReferenceItem2
 {
     public string Name => referenceItem.Name;
 
-    public IReadOnlyDictionary<string, string>? Metadata => referenceItem.Properties;
+    public IReadOnlyDictionary<string, string>? Metadata => referenceItem.Metadata;
 }

src/Microsoft.VisualStudio.ProjectSystem.Managed/ProjectSystem/PackageRestore/Snapshots/ReferenceItem.cs

@@ -12,12 +12,12 @@ internal sealed class ReferenceItem
 {
     // If additional state is added to this class, please update RestoreHasher
 
-    public ReferenceItem(string name, IImmutableDictionary<string, string> properties)
+    public ReferenceItem(string name, IImmutableDictionary<string, string> metadata)
     {
         Requires.NotNullOrEmpty(name);
 
         Name = name;
-        Properties = properties;
+        Metadata = metadata;
     }
 
     /// <summary>
@@ -28,5 +28,5 @@ public ReferenceItem(string name, IImmutableDictionary<string, string> propertie
     /// <summary>
     /// Gets the name/value pair metadata associated with the reference.
     /// </summary>
-    public IImmutableDictionary<string, string> Properties { get; }
+    public IImmutableDictionary<string, string> Metadata { get; }
 }

src/Microsoft.VisualStudio.ProjectSystem.Managed/ProjectSystem/PackageRestore/Snapshots/RestoreComparer.ReferenceItemEqualityComparer.cs

@@ -14,7 +14,7 @@ public override bool Equals(ReferenceItem? x, ReferenceItem? y)
             if (!StringComparers.ItemNames.Equals(x.Name, y.Name))
                 return false;
 
-            if (!PropertiesAreEqual(x.Properties, y.Properties))
+            if (!PropertiesAreEqual(x.Metadata, y.Metadata))
                 return false;
 
             return true;

src/Microsoft.VisualStudio.ProjectSystem.Managed/ProjectSystem/PackageRestore/Snapshots/RestoreHasher.cs

@@ -52,7 +52,7 @@ private static void AppendReferences(this IncrementalHasher hasher, ImmutableArr
 
     private static void AppendReferenceProperties(this IncrementalHasher hasher, ReferenceItem reference)
     {
-        foreach ((string key, string value) in reference.Properties)
+        foreach ((string key, string value) in reference.Metadata)
         {
             hasher.AppendProperty(key, value);
         }

src/Microsoft.VisualStudio.ProjectSystem.Managed/ProjectSystem/PackageRestore/Snapshots/RestoreLogger.cs

@@ -86,7 +86,7 @@ private static void LogReferenceItems(BatchLogger logger, string heading, Immuta
 
         foreach (ReferenceItem reference in references)
         {
-            IEnumerable<string> properties = reference.Properties.Select(prop => $"{prop.Key}:{prop.Value}");
+            IEnumerable<string> properties = reference.Metadata.Select(prop => $"{prop.Key}:{prop.Value}");
 
             logger.WriteLine($"{reference.Name} -- ({string.Join(" | ", properties)})");
         }

tests/Microsoft.VisualStudio.ProjectSystem.Managed.UnitTests/ProjectSystem/PackageRestore/Snapshots/RestoreBuilderTests.cs

@@ -192,15 +192,15 @@ public void ToProjectRestoreInfo_SetsToolReferences()
 
         var toolReference1 = references.FirstOrDefault(r => r.Name == "ToolReference1");
         Assert.NotNull(toolReference1);
-        AssertContainsProperty("Version", "1.0.0.0", toolReference1.Properties);
+        AssertContainsProperty("Version", "1.0.0.0", toolReference1.Metadata);
 
         var toolReference2 = references.FirstOrDefault(r => r.Name == "ToolReference2");
         Assert.NotNull(toolReference2);
-        AssertContainsProperty("Version", "2.0.0.0", toolReference2.Properties);
+        AssertContainsProperty("Version", "2.0.0.0", toolReference2.Metadata);
 
         var toolReference3 = references.FirstOrDefault(r => r.Name == "ToolReference3");
         Assert.NotNull(toolReference3);
-        AssertContainsProperty("Name", "Value", toolReference3.Properties);
+        AssertContainsProperty("Name", "Value", toolReference3.Metadata);
     }
 
     [Fact]
@@ -234,15 +234,15 @@ public void ToProjectRestoreInfo_SetsPackageReferences()
 
         var packageReference1 = references.FirstOrDefault(r => r.Name == "PackageReference1");
         Assert.NotNull(packageReference1);
-        AssertContainsProperty("Version", "1.0.0.0", packageReference1.Properties);
+        AssertContainsProperty("Version", "1.0.0.0", packageReference1.Metadata);
 
         var packageReference2 = references.FirstOrDefault(r => r.Name == "PackageReference2");
         Assert.NotNull(packageReference2);
-        AssertContainsProperty("Version", "2.0.0.0", packageReference2.Properties);
+        AssertContainsProperty("Version", "2.0.0.0", packageReference2.Metadata);
 
         var packageReference3 = references.FirstOrDefault(r => r.Name == "PackageReference3");
         Assert.NotNull(packageReference3);
-        AssertContainsProperty("Name", "Value", packageReference3.Properties);
+        AssertContainsProperty("Name", "Value", packageReference3.Metadata);
     }
 
     [Fact]
@@ -276,17 +276,17 @@ public void ToProjectRestoreInfo_SetsCentralPackageVersions()
 
         var reference1 = versions.FirstOrDefault(r => r.Name == "Newtonsoft.Json");
         Assert.NotNull(reference1);
-        AssertContainsProperty("Version", "1.0", reference1.Properties);
+        AssertContainsProperty("Version", "1.0", reference1.Metadata);
 
         var reference2 = versions.FirstOrDefault(r => r.Name == "System.IO");
         Assert.NotNull(reference2);
-        AssertContainsProperty("Version", "2.0", reference2.Properties);
+        AssertContainsProperty("Version", "2.0", reference2.Metadata);
 
         var reference3 = versions.FirstOrDefault(r => r.Name == "Microsoft.Extensions");
         Assert.NotNull(reference3);
         Assert.Equal("Microsoft.Extensions", reference3.Name);
 
-        AssertContainsProperty("Version", "3.0", reference3.Properties);
+        AssertContainsProperty("Version", "3.0", reference3.Metadata);
     }
 
     [Fact]
@@ -344,17 +344,17 @@ public void ToProjectRestoreInfo_SetsPrunePackageReferences()
 
         var reference1 = prunePackageReferences.FirstOrDefault(r => r.Name == "Newtonsoft.Json");
         Assert.NotNull(reference1);
-        AssertContainsProperty("Version", "1.0", reference1.Properties);
+        AssertContainsProperty("Version", "1.0", reference1.Metadata);
 
         var reference2 = prunePackageReferences.FirstOrDefault(r => r.Name == "System.IO");
         Assert.NotNull(reference2);
-        AssertContainsProperty("Version", "2.0", reference2.Properties);
+        AssertContainsProperty("Version", "2.0", reference2.Metadata);
 
         var reference3 = prunePackageReferences.FirstOrDefault(r => r.Name == "Microsoft.Extensions");
         Assert.NotNull(reference3);
         Assert.Equal("Microsoft.Extensions", reference3.Name);
 
-        AssertContainsProperty("Version", "3.0", reference3.Properties);
+        AssertContainsProperty("Version", "3.0", reference3.Metadata);
     }
 
     [Fact]
@@ -389,16 +389,16 @@ public void ToProjectRestoreInfo_SetsProjectReferences()
 
         var reference1 = references.FirstOrDefault(p => p.Name == "..\\Project\\Project1.csproj");
         Assert.NotNull(reference1);
-        AssertContainsProperty("ProjectFileFullPath", "C:\\Solution\\Project\\Project1.csproj", reference1.Properties);
+        AssertContainsProperty("ProjectFileFullPath", "C:\\Solution\\Project\\Project1.csproj", reference1.Metadata);
 
         var reference2 = references.FirstOrDefault(p => p.Name == "..\\Project\\Project2.csproj");
         Assert.NotNull(reference2);
-        AssertContainsProperty("ProjectFileFullPath", "C:\\Solution\\Project\\Project2.csproj", reference2.Properties);
+        AssertContainsProperty("ProjectFileFullPath", "C:\\Solution\\Project\\Project2.csproj", reference2.Metadata);
 
         var reference3 = references.FirstOrDefault(p => p.Name == "..\\Project\\Project3.csproj");
         Assert.NotNull(reference3);
-        AssertContainsProperty("ProjectFileFullPath", "C:\\Solution\\Project\\Project3.csproj", reference3.Properties);
-        AssertContainsProperty("MetadataName", "MetadataValue", reference3.Properties);
+        AssertContainsProperty("ProjectFileFullPath", "C:\\Solution\\Project\\Project3.csproj", reference3.Metadata);
+        AssertContainsProperty("MetadataName", "MetadataValue", reference3.Metadata);
     }
 
     [Fact]
@@ -428,11 +428,11 @@ public void ToProjectRestoreInfo_SetsFrameworkReferences()
 
         var reference1 = references.FirstOrDefault(r => r.Name == "WindowsForms");
         Assert.NotNull(reference1);
-        Assert.Empty(reference1.Properties);
+        Assert.Empty(reference1.Metadata);
 
         var reference2 = references.FirstOrDefault(r => r.Name == "WPF");
         Assert.NotNull(reference2);
-        AssertContainsProperty("PrivateAssets", "all", reference2.Properties);
+        AssertContainsProperty("PrivateAssets", "all", reference2.Metadata);
     }
 
     [Fact]
@@ -463,11 +463,11 @@ public void ToProjectRestoreInfo_SetsPackageDownloads()
 
         var download1 = downloads.FirstOrDefault(d => d.Name == "NuGet.Common");
         Assert.NotNull(download1);
-        AssertContainsProperty("Version", "[4.0.0];[5.0.0]", download1.Properties);
+        AssertContainsProperty("Version", "[4.0.0];[5.0.0]", download1.Metadata);
 
         var download2 = downloads.FirstOrDefault(d => d.Name == "NuGet.Frameworks");
         Assert.NotNull(download2);
-        AssertContainsProperty("Version", "[4.9.4]", download2.Properties);
+        AssertContainsProperty("Version", "[4.9.4]", download2.Metadata);
     }
 
     private static void AssertContainsProperty(string name, string value, IImmutableDictionary<string, string> properties)