Enabling nullability in NuGet.Packaging - phase 1, models and simple classes (#7176)

Author: nkolev92

src/NuGet.Clients/NuGet.VisualStudio.Internal.Contracts/Formatters/PackageIdentityFormatter.cs

@@ -40,8 +40,11 @@ private PackageIdentityFormatter()
                         break;
                 }
             }
-
-            return new PackageIdentity(id, version);
+            if (id != null)
+            {
+                return new PackageIdentity(id, version);
+            }
+            return null;
         }
 
         protected override void SerializeCore(ref MessagePackWriter writer, PackageIdentity value, MessagePackSerializerOptions options)

src/NuGet.Core/NuGet.CommandLine.XPlat/Commands/Package/Update/PackageUpdateCommandRunner.cs

@@ -180,7 +180,7 @@ internal static async Task<int> Run(PackageUpdateArgs args, ILoggerWithColor log
                 .SelectMany(tf => tf.Libraries.Select(library => (tf.TargetFramework, library)))
                 .Where(tuple => tuple.library.Type == "package" && packageIdsWithVulnerabilities.Contains(tuple.library.Name!) && PackageHasVulnerability(tuple.library.Name!, tuple.library.Version!, knownVulnerabilities))
                 .GroupBy(
-                    pair => new PackageIdentity(pair.library.Name, pair.library.Version),
+                    pair => new PackageIdentity(pair.library.Name!, pair.library.Version),
                     pair => assetsFile.PackageSpec.TargetFrameworks.Single(tfm => tfm.FrameworkName == pair.TargetFramework).TargetAlias,
                     (key, g) => (key, g.Distinct().ToList()))
                 .ToList();

src/NuGet.Core/NuGet.Commands/PackagesLockFileBuilder.cs

@@ -45,7 +45,7 @@ public PackagesLockFile CreateNuGetLockFile(LockFile assetsFile)
 
                 foreach (var library in libraries.Where(e => e.Type == LibraryType.Package))
                 {
-                    var identity = new PackageIdentity(library.Name, library.Version);
+                    var identity = new PackageIdentity(library.Name!, library.Version);
 
                     var dependency = new LockFileDependency()
                     {
@@ -92,7 +92,7 @@ public PackagesLockFile CreateNuGetLockFile(LockFile assetsFile)
 
                 foreach (var projectReference in libraries.Where(e => e.Type == LibraryType.Project || e.Type == LibraryType.ExternalProject))
                 {
-                    var projectIdentity = new PackageIdentity(projectReference.Name, projectReference.Version);
+                    var projectIdentity = new PackageIdentity(projectReference.Name!, projectReference.Version);
                     var projectFullPath = projectFullPaths[projectIdentity];
                     var id = PathUtility.GetStringComparerBasedOnOS().Equals(Path.GetFileNameWithoutExtension(projectFullPath), projectReference.Name)
                         ? projectReference.Name.ToLowerInvariant()

src/NuGet.Core/NuGet.Packaging/Core/ContentFilesEntry.cs

@@ -1,8 +1,6 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
-#nullable disable
-
 using System;
 
 namespace NuGet.Packaging.Core
@@ -21,12 +19,12 @@ public class ContentFilesEntry
         /// <summary>
         /// Excluded files
         /// </summary>
-        public string Exclude { get; }
+        public string? Exclude { get; }
 
         /// <summary>
         /// Build action
         /// </summary>
-        public string BuildAction { get; }
+        public string? BuildAction { get; }
 
         /// <summary>
         /// If true the item will be copied to the output folder.
@@ -41,8 +39,8 @@ public class ContentFilesEntry
 
         public ContentFilesEntry(
             string include,
-            string exclude,
-            string buildAction,
+            string? exclude,
+            string? buildAction,
             bool? copyToOutput,
             bool? flatten)
         {

src/NuGet.Core/NuGet.Packaging/Core/FrameworkReference.cs

@@ -1,8 +1,6 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
-#nullable disable
-
 using System;
 using System.Collections.Generic;
 using NuGet.Common;
@@ -19,12 +17,27 @@ public FrameworkReference(string name)
             Name = name ?? throw new ArgumentNullException(nameof(name));
         }
 
-        public int Compare(FrameworkReference x, FrameworkReference y)
+        public int Compare(FrameworkReference? x, FrameworkReference? y)
         {
+            if (ReferenceEquals(x, y))
+            {
+                return 0;
+            }
+
+            if (x is null)
+            {
+                return -1;
+            }
+
+            if (y is null)
+            {
+                return 1;
+            }
+
             return ComparisonUtility.FrameworkReferenceNameComparer.Compare(x.Name, y.Name);
         }
 
-        public bool Equals(FrameworkReference other)
+        public bool Equals(FrameworkReference? other)
         {
             if (other == null)
             {
@@ -39,7 +52,7 @@ public bool Equals(FrameworkReference other)
             return ComparisonUtility.FrameworkReferenceNameComparer.Equals(Name, other.Name);
         }
 
-        public override bool Equals(object obj)
+        public override bool Equals(object? obj)
         {
             return Equals(obj as FrameworkReference);
         }
@@ -51,7 +64,7 @@ public override int GetHashCode()
             return combiner.CombinedHash;
         }
 
-        public int CompareTo(FrameworkReference other)
+        public int CompareTo(FrameworkReference? other)
         {
             return Compare(this, other);
         }

src/NuGet.Core/NuGet.Packaging/Core/FrameworkReferenceGroup.cs

@@ -1,8 +1,6 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
-#nullable disable
-
 using System;
 using System.Collections.Generic;
 using NuGet.Frameworks;
@@ -36,7 +34,7 @@ public FrameworkReferenceGroup(NuGetFramework targetFramework, IEnumerable<Frame
         /// </summary>
         public IEnumerable<FrameworkReference> FrameworkReferences { get; }
 
-        public bool Equals(FrameworkReferenceGroup other)
+        public bool Equals(FrameworkReferenceGroup? other)
         {
             if (ReferenceEquals(other, null))
             {
@@ -52,7 +50,7 @@ public bool Equals(FrameworkReferenceGroup other)
                    FrameworkReferences.OrderedEquals(other.FrameworkReferences, dependency => dependency);
         }
 
-        public override bool Equals(object obj)
+        public override bool Equals(object? obj)
         {
             return Equals(obj as FrameworkReferenceGroup);
         }

src/NuGet.Core/NuGet.Packaging/Core/FrameworkSpecificGroup.cs

@@ -1,8 +1,6 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
-#nullable disable
-
 using System;
 using System.Collections.Generic;
 using System.Linq;
@@ -66,7 +64,7 @@ public IEnumerable<string> Items
 
         public bool HasEmptyFolder { get; }
 
-        public bool Equals(FrameworkSpecificGroup other)
+        public bool Equals(FrameworkSpecificGroup? other)
         {
             if (ReferenceEquals(this, other))
             {
@@ -81,7 +79,7 @@ public bool Equals(FrameworkSpecificGroup other)
             return GetHashCode() == other.GetHashCode();
         }
 
-        public override bool Equals(object obj)
+        public override bool Equals(object? obj)
         {
             var other = obj as FrameworkSpecificGroup;
 

src/NuGet.Core/NuGet.Packaging/Core/PackageDependency.cs

@@ -1,8 +1,6 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
-#nullable disable
-
 using System;
 using System.Collections.Generic;
 using System.Globalization;
@@ -49,16 +47,16 @@ public PackageDependency(string id)
         }
 
         [JsonConstructor]
-        public PackageDependency(string id, VersionRange versionRange)
+        public PackageDependency(string id, VersionRange? versionRange)
             : this(id, versionRange, include: null, exclude: null)
         {
         }
 
         public PackageDependency(
             string id,
-            VersionRange versionRange,
-            IReadOnlyList<string> include,
-            IReadOnlyList<string> exclude)
+            VersionRange? versionRange,
+            IReadOnlyList<string>? include,
+            IReadOnlyList<string>? exclude)
         {
             if (string.IsNullOrEmpty(id))
             {
@@ -71,12 +69,12 @@ public PackageDependency(
             Exclude = exclude ?? EmptyList;
         }
 
-        public bool Equals(PackageDependency other)
+        public bool Equals(PackageDependency? other)
         {
             return PackageDependencyComparer.Default.Equals(this, other);
         }
 
-        public override bool Equals(object obj)
+        public override bool Equals(object? obj)
         {
             var dependency = obj as PackageDependency;
 

src/NuGet.Core/NuGet.Packaging/Core/PackageDependencyGroup.cs

@@ -1,8 +1,6 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
-#nullable disable
-
 using System;
 using System.Collections.Generic;
 using System.Globalization;
@@ -22,7 +20,7 @@ public class PackageDependencyGroup : IEquatable<PackageDependencyGroup>, IFrame
         private readonly IEnumerable<PackageDependency> _packages;
 
         [JsonConstructor]
-        private PackageDependencyGroup(NuGetFramework targetFramework)
+        private PackageDependencyGroup(NuGetFramework? targetFramework)
         {
             if (targetFramework == null)
             {
@@ -75,12 +73,12 @@ public IEnumerable<PackageDependency> Packages
             get { return _packages; }
         }
 
-        public override bool Equals(object obj)
+        public override bool Equals(object? obj)
         {
             return Equals(obj as PackageDependencyGroup);
         }
 
-        public bool Equals(PackageDependencyGroup other)
+        public bool Equals(PackageDependencyGroup? other)
         {
             if (other == null)
             {

src/NuGet.Core/NuGet.Packaging/Core/PackageDependencyInfo.cs

@@ -23,7 +23,7 @@ public class PackageDependencyInfo : PackageIdentity, IEquatable<PackageDependen
         /// </summary>
         public IEnumerable<PackageDependency> Dependencies { get; }
 
-        public PackageDependencyInfo(string id, NuGetVersion version)
+        public PackageDependencyInfo(string id, NuGetVersion? version)
             : this(id, version, null)
         {
         }
@@ -39,7 +39,7 @@ public PackageDependencyInfo(PackageIdentity identity, IEnumerable<PackageDepend
         /// <param name="id">package name</param>
         /// <param name="version">package version</param>
         /// <param name="dependencies">package dependencies</param>
-        public PackageDependencyInfo(string id, NuGetVersion version, IEnumerable<PackageDependency>? dependencies)
+        public PackageDependencyInfo(string id, NuGetVersion? version, IEnumerable<PackageDependency>? dependencies)
             : base(id, version)
         {
             Dependencies = dependencies?.ToArray() ?? Array.Empty<PackageDependency>();