Improvement: The NuGet installer now respects IntentIgnore="true" on <PackageReference /> elements in .csproj files.

Author: JonathanLydall

Modules/Intent.Modules.VisualStudio.Projects.Tests/NuGet/SchemeTests/SdkSchemeTests.cs

@@ -8,6 +8,7 @@
 using Intent.Modules.VisualStudio.Projects.Settings;
 using Intent.Modules.VisualStudio.Projects.Tests.NuGet.Helpers;
 using NuGet.Versioning;
+using Shouldly;
 using VerifyTests;
 using VerifyXunit;
 using Xunit;
@@ -192,5 +193,56 @@ public void SortsPackageReferencesInAlphabeticalOrder(TestPackage existingPackag
 </Project>".ReplaceLineEndings(),
                 actual: result.ReplaceLineEndings());
         }
+
+        [Fact]
+        public void ItShouldRespectIgnore()
+        {
+            // Arrange
+            var sut = TestFixtureHelper.CreateSdkProcessor();
+            var tracing = new TestTracing();
+            var project = TestFixtureHelper.CreateNuGetProject(
+                scheme: VisualStudioProjectScheme.Sdk,
+                processor: sut,
+                testVersion: TestVersion.Low,
+                testPackage: TestPackage.One,
+                nugetPackagesToInstall: new Dictionary<string, string>
+                {
+                    { "TestPackage", "2.0.0" }
+                });
+
+            // Act
+            var result = sut.InstallPackages(
+                solutionModelId: string.Empty,
+                projectStereotypes: Enumerable.Empty<IStereotype>(),
+                projectPath: null,
+                projectContent:
+                    """
+                    <Project Sdk="Microsoft.NET.Sdk">
+
+                      <ItemGroup>
+                        <PackageReference Include="TestPackage" Version="1.0.0" IntentIgnore="true" />
+                      </ItemGroup>
+
+                    </Project>
+                    """,
+                requestedPackages: project.RequestedPackages,
+                installedPackages: project.InstalledPackages,
+                toRemovePackages: new List<string>(),
+                projectName: project.Name,
+                tracing: tracing,
+                dependencyVersionOverwriteBehavior: DependencyVersionOverwriteBehaviorOption.IfNewer);
+
+            // Assert
+            result.ReplaceLineEndings().ShouldBe(
+                """
+                <Project Sdk="Microsoft.NET.Sdk">
+
+                  <ItemGroup>
+                    <PackageReference Include="TestPackage" Version="1.0.0" IntentIgnore="true" />
+                  </ItemGroup>
+
+                </Project>
+                """.ReplaceLineEndings());
+        }
     }
 }

Modules/Intent.Modules.VisualStudio.Projects/FactoryExtensions/NuGet/SchemeProcessors/SdkSchemeProcessor.cs

@@ -156,27 +156,39 @@ public string InstallPackages(
             }
 
             var currentVersions = new List<VersionInfo>(2);
-            var projectVersionMetadata = packageReferenceItem.Metadata.SingleOrDefault(x => string.Equals(x.Name, "Version", StringComparison.OrdinalIgnoreCase));
-            if (projectVersionMetadata != null)
+            var packageVersionMetadata = packageReferenceItem.Metadata.SingleOrDefault(x => string.Equals(x.Name, "Version", StringComparison.OrdinalIgnoreCase));
+            if (packageVersionMetadata != null)
             {
-                currentVersions.Add(new VersionInfo( projectVersionMetadata.Value));
+                if (packageReferenceItem.Metadata.Any(x => string.Equals(x.Name, "IntentIgnore", StringComparison.OrdinalIgnoreCase) &&
+                                                           string.Equals(x.Value, "true", StringComparison.OrdinalIgnoreCase)))
+                {
+                    continue;
+                }
+
+                currentVersions.Add(new VersionInfo(packageVersionMetadata.Value));
             }
 
             if (cpmTemplate.TryGetVersion(packageId, out var cpmVersion))
             {
+                if (packageReferenceItem.Metadata.Any(x => string.Equals(x.Name, "IntentIgnore", StringComparison.OrdinalIgnoreCase) &&
+                                                           string.Equals(x.Value, "true", StringComparison.OrdinalIgnoreCase)))
+                {
+                    continue;
+                }
+
                 currentVersions.Add(new VersionInfo(cpmVersion));
             }
 
             var currentVersion = currentVersions.Any()
                 ? currentVersions.Max()
                 : null;
 
-            if (!isUsingCpm && projectVersionMetadata == null)
+            if (!isUsingCpm && packageVersionMetadata == null)
             {
                 var toVersion = currentVersion != null && currentVersion > requestedVersion
                     ? currentVersion
                     : requestedVersion;
-                projectVersionMetadata = packageReferenceItem.AddMetadata("Version", toVersion.Version, expressAsAttribute: true);
+                packageVersionMetadata = packageReferenceItem.AddMetadata("Version", toVersion.Version, expressAsAttribute: true);
             }
 
             switch (dependencyVersionOverwriteBehavior)
@@ -192,7 +204,7 @@ public string InstallPackages(
                     else if (!isUsingCpm)
                     {
                         tracing.Info($"Updating {packageId} from \"{currentVersion?.Version}\" to \"{requestedVersion.Version}\" in project \"{projectName}\"");
-                        projectVersionMetadata.Value = requestedVersion.Version;
+                        packageVersionMetadata.Value = requestedVersion.Version;
                     }
 
                     break;

Modules/Intent.Modules.VisualStudio.Projects/Intent.VisualStudio.Projects.imodspec

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <package>
   <id>Intent.VisualStudio.Projects</id>
-  <version>3.9.3</version>
+  <version>3.9.4-pre.0</version>
   <supportedClientVersions>[4.5.15-a, 5.0.0-a)</supportedClientVersions>
   <summary>Visual Studio solution and project layout designer</summary>
   <description>Visual Studio solution and project layout designer</description>

Modules/Intent.Modules.VisualStudio.Projects/release-notes.md

@@ -1,3 +1,7 @@
+### Version 3.9.4
+
+- Improvement: The NuGet installer now respects `IntentIgnore="true"` on `<PackageReference />` elements in `.csproj` files.
+
 ### Version 3.9.3
 
 - Improvement: Added `BaseUrl` stereotype to the relevent project, so that other applications creating proxies can read the URL value.