Code cleanup

Author: ocalles

src/Tasks/Microsoft.NET.Build.Tasks/ResolvePackageAssets.cs

@@ -12,7 +12,6 @@
 using Microsoft.Build.Framework;
 using Microsoft.Build.Utilities;
 using NuGet.Common;
-using NuGet.Frameworks;
 using NuGet.ProjectModel;
 using NuGet.Versioning;
 
@@ -161,6 +160,11 @@ public sealed class ResolvePackageAssets : TaskBase
         /// </summary>
         public bool DesignTimeBuild { get; set; }
 
+        /// <summary>
+        /// Enable publishing XML documentation
+        /// </summary>
+        public bool PublishReferencesDocumentationFiles { get; set; }
+
         /// <summary>
         /// Full paths to assemblies from packages to pass to compiler as analyzers.
         /// </summary>
@@ -235,14 +239,23 @@ public sealed class ResolvePackageAssets : TaskBase
         public ITaskItem[] PackageDependencies { get; private set; }
 
         /// <summary>
-        /// List of file symbols pdb and xml related to NuGet packages
+        /// List of symbol files (.pdb) related to NuGet packages.
         /// </summary>
         /// <remarks>
-        /// This is the list of files to be copied to the output directory
+        /// Pdb files to be copied to the output directory
         /// </remarks>
         [Output]
         public ITaskItem[] DebugSymbolsFiles { get; private set;}
 
+        /// <summary>
+        /// List of xml files related to NuGet packages.
+        /// </summary>
+        /// <remarks>
+        ///  The XML files should only be included in the publish output if PublishReferencesDocumentationFiles is true
+        /// </remarks>
+        [Output]
+        public ITaskItem[] DebugXmlFiles { get; private set; }
+
         /// <summary>
         /// Messages from the assets file.
         /// These are logged directly and therefore not returned to the targets (note private here).
@@ -324,6 +337,7 @@ private void ReadItemGroups()
                 CompileTimeAssemblies = reader.ReadItemGroup();
                 ContentFilesToPreprocess = reader.ReadItemGroup();
                 DebugSymbolsFiles = reader.ReadItemGroup();
+                DebugXmlFiles = reader.ReadItemGroup();
                 FrameworkAssemblies = reader.ReadItemGroup();
                 FrameworkReferences = reader.ReadItemGroup();
                 NativeLibraries = reader.ReadItemGroup();
@@ -456,6 +470,7 @@ internal byte[] HashSettings()
                     }
                     writer.Write(TargetFramework);
                     writer.Write(VerifyMatchingImplicitPackageVersion);
+                    writer.Write(PublishReferencesDocumentationFiles);
                 }
 
                 stream.Position = 0;
@@ -794,6 +809,7 @@ private void WriteItemGroups()
                 WriteItemGroup(WriteCompileTimeAssemblies);
                 WriteItemGroup(WriteContentFilesToPreprocess);
                 WriteItemGroup(WriteDebugSymbolsFiles);
+                WriteItemGroup(WriteDebugXmlFiles);
                 WriteItemGroup(WriteFrameworkAssemblies);
                 WriteItemGroup(WriteFrameworkReferences);
                 WriteItemGroup(WriteNativeLibraries);
@@ -1111,14 +1127,34 @@ private void WriteContentFilesToPreprocess()
 
             private void WriteDebugSymbolsFiles()
             {
-                foreach (LockFileTargetLibrary library in _runtimeTarget.Libraries)
+                WriteDebugItems(
+                    p => p.RuntimeAssemblies,
+                    MetadataKeys.PdbExtension);
+            }
+
+            private void WriteDebugXmlFiles()
+            {
+                if (_task.PublishReferencesDocumentationFiles)
+                {
+                    WriteDebugItems(
+                        p => p.CompileTimeAssemblies,
+                        MetadataKeys.XmlExtension);
+                }
+            }
+
+            private void WriteDebugItems<T>(
+                Func<LockFileTargetLibrary, IEnumerable<T>> getAssets,
+                string extension)
+                where T : LockFileItem
+            {
+                foreach (var library in _runtimeTarget.Libraries)
                 {
                     if (!library.IsPackage())
                     {
                         continue;
                     }
 
-                    foreach (var asset in library.RuntimeAssemblies)
+                    foreach (T asset in getAssets(library))
                     {
                         if (asset.IsPlaceholderFile() || !asset.Properties.ContainsKey(MetadataKeys.RelatedProperty))
                         {
@@ -1131,14 +1167,9 @@ private void WriteDebugSymbolsFiles()
 
                         foreach (string fileExtension in relatedExtensions.Split(RelatedPropertySeparator))
                         {
-                            switch (fileExtension.ToLower())
+                            if (fileExtension.ToLower() == extension)
                             {
-                                case MetadataKeys.PdbExtension:
-                                    WriteItem(Path.ChangeExtension(itemSpec, MetadataKeys.PdbExtension), library);
-                                    break;
-                                case MetadataKeys.XmlExtension:
-                                    WriteItem(Path.ChangeExtension(itemSpec, MetadataKeys.XmlExtension), library);
-                                    break;
+                                WriteItem(Path.ChangeExtension(itemSpec, extension), library);
                             }
                         }
                     }

src/Tasks/Microsoft.NET.Build.Tasks/targets/Microsoft.PackageDependencyResolution.targets

@@ -290,14 +290,16 @@ Copyright (c) .NET Foundation. All rights reserved.
       SatelliteResourceLanguages="$(SatelliteResourceLanguages)"
       DesignTimeBuild="$(DesignTimeBuild)"
       ContinueOnError="$(ContinueOnError)"
-      PackageReferences="@(PackageReference)">
+      PackageReferences="@(PackageReference)"
+      PublishReferencesDocumentationFiles="$(PublishReferencesDocumentationFiles)">
 
       <!-- NOTE: items names here are inconsistent because they match prior implementation
           (that was spread across different tasks/targets) for backwards compatibility.  -->
       <Output TaskParameter="Analyzers" ItemName="ResolvedAnalyzers" />
       <Output TaskParameter="ApphostsForShimRuntimeIdentifiers" ItemName="_ApphostsForShimRuntimeIdentifiersResolvePackageAssets" />
       <Output TaskParameter="ContentFilesToPreprocess" ItemName="_ContentFilesToPreprocess" />
       <Output TaskParameter="DebugSymbolsFiles" ItemName="ReferenceCopyLocalPaths" />
+      <Output TaskParameter="DebugXmlFiles" ItemName="ReferenceCopyLocalPaths" />
       <Output TaskParameter="FrameworkAssemblies" ItemName="ResolvedFrameworkAssemblies" />
       <Output TaskParameter="FrameworkReferences" ItemName="TransitiveFrameworkReference" />
       <Output TaskParameter="NativeLibraries" ItemName="NativeCopyLocalItems" />