MSBuildFacts.cs

using System;
using System.Collections.Generic;
using System.Collections.Immutable;

namespace MSBuild.Conversion.Facts
{
    /// <summary>
    /// A bunch of values regarding MSBuild project files.
    /// </summary>
    public static class MSBuildFacts
    {
        /// <summary>
        /// Props files which are known to be imported in standard projects created from templates that can be omitted from SDK projects.
        /// </summary>
        public static ImmutableArray<string> PropsToRemove => ImmutableArray.Create(
            "Microsoft.Common.props",
            "MSTest.TestAdapter.props",
            "Microsoft.CodeDom.Providers.DotNetCompilerPlatform.props",
            "Microsoft.Net.Compilers.props" // https://stackoverflow.com/a/60623906
        );

        /// <summary>
        /// Targets files which are known to be imported in standard projects created from templates that can be omitted from SDK projects.
        /// </summary>
        public static ImmutableArray<string> TargetsToRemove => ImmutableArray.Create(
            "Microsoft.CSharp.targets",
            "Microsoft.VisualBasic.targets",
            "Microsoft.Portable.CSharp.targets",
            "Microsoft.Portable.VisualBasic.targets",
            "Microsoft.FSharp.Targets",
            "MSTest.TestAdapter.targets",
            "Microsoft.TestTools.targets",
            "Microsoft.WebApplication.targets"
        );

        /// <summary>
        /// Props and targets files which are recognized and can be left unchanged during conversion.
        /// </summary>
        public static ImmutableArray<string> ImportsToKeep => ImmutableArray.Create(
            "Microsoft.TypeScript.Default.props",
            "Microsoft.TypeScript.targets"
        );

        /// <summary>
        /// Mapping of PCL profiles to netstandard versions.
        /// </summary>
        public static ImmutableDictionary<string, string> PCLToNetStandardVersionMapping => ImmutableDictionary.CreateRange(new Dictionary<string, string>
        {
            // https://github.com/dotnet/standard/blob/main/docs/versions.md#mapping-pcl-profiles-to-net-standard
            { "Profile7",        "1.1"  },
            { "Profile31",       "1.0"  },
            { "Profile32",       "1.2"  },
            { "Profile44",       "1.2"  },
            { "Profile49",       "1.0"  },
            { "Profile78",       "1.0"  },
            { "Profile84",       "1.0"  },
            { "Profile111",      "1.1"  },
            { "Profile151",      "1.2"  },
            { "Profile157",      "1.0"  },
            { "Profile259",      "1.0"  },
        });

        public static ImmutableArray<string> GlobbedItemTypes => ImmutableArray.Create(
            "Compile",
            "EmbeddedResource",
            "None",
            "Page",
            "ApplicationDefinition"
            );

        public static ImmutableArray<string> UnnecessaryProperties => ImmutableArray.Create(
            // The following are unecessary in CPS and/or are already in the .NET SDK
            "OldToolsVersion",
            "ProjectGuid",
            "ProjectTypeGuids",
            "TargetFrameworkIdentifier",
            "TargetFrameworkVersion",
            "TargetFrameworkProfile",
            "FSharpTargetsPath",

            // This is not applicable in most cases, as older VS versions won't work with any modern .NET Core
            "MinimumVisualStudioVersion",

            // This is so unlikely to be changed from the default that we can just remove it
            "SchemaVersion",

            // This is set by F# legacy templates, but since we default to 64-bit on .NET Core this is unlikely to ever be meaningful
            "Prefer32Bit",

            // This is dropped in by templates and is so unlikely to ever be set that it's not worth keeping
            "VSToolsPath",

            // This is dropped in by templates, but is unlikely to be valid given that the .NET SDK specifies a minimum VS version that will work
            "VisualStudioVersion",

            // ASP.NET Core always defaults to building views
            "MvcBuildViews",

            // ASP.NET Core does not configure IIS settings in the project file
            "UseIISExpress",
            "Use64BitIISExpress",
            "IISExpressSSLPort",
            "IISExpressAnonymousAuthentication",
            "IISExpressWindowsAuthentication",
            "IISExpressUseClassicPipelineMode",

            // No longer used in ASP.NET Core
            "MvcProjectUpgradeChecked",
            "UseGlobalApplicationHostFile",

            // Not needed for converted UWP apps
            "TargetPlatformIdentifier",
            "TargetPlatformVersion"
        );

        public static ImmutableArray<string> DefaultDefineConstants => ImmutableArray.Create(
            "DEBUG",
            "TRACE"
        );

        public static ImmutableArray<string> DefaultOutputPaths => ImmutableArray.Create(
            @"bin\Release\",
            @"bin\Debug\",
            @"bin\$(Configuration)\"
        );

        public static ImmutableArray<string> DefaultPlatformTargets => ImmutableArray.Create(
            "AnyCPU"
        );

        public static ImmutableArray<string> DefaultDebugTypes => ImmutableArray.Create(
            "full",
            "pdbonly"
        );

        public static ImmutableArray<string> UnnecessaryItemIncludes => ImmutableArray.Create(
            // FSharp.Core is referenced by default in the .NET SDK
            "FSharp.Core",

            // F# explicitly references this in old-style projects; it's not needed now
            "mscorlib",

            // App.config is now deprecated, user needs to use to appsettings.json
            "App.config",

            // packages.config is now deprecated, user needs to move to PackageReference
            "packages.config",

            // Enterprise Services is no longer supported
            "System.EnterpriseServices",

            // System.Net.Http is a part of the .NET SDK now
            "System.Net.Http"
        );

        public static ImmutableArray<string> UnnecessaryWebIncludes => ImmutableArray.Create(
            // ASP.NET references are no longer used by web apps
            "System.Web",
            "System.Web.Abstractions",
            "System.Web.ApplicationServices",
            "System.Web.DataVisualization",
            "System.Web.DynamicData",
            "System.Web.Entity",
            "System.Web.Extensions",
            "System.Web.Extensions.Design",
            "System.Web.Helpers",
            "System.Web.Mobile",
            "System.Web.Mvc",
            "System.Web.Optimization",
            "System.Web.Razor",
            "System.Web.Routing",
            "System.Web.Services",
            "System.Web.WebPages",
            "System.Web.WebPages.Deployment",
            "System.Web.WebPages.Razor",
            "System.Net.Http.WebRequest",
            "Microsoft.AspNet.Mvc",
            "Microsoft.AspNet.Razor",
            "Microsoft.AspNet.Identity.Core",
            "Microsoft.AspNet.Identity.EntityFramework",
            "Microsoft.AspNet.Identity.Owin",
            "Microsoft.AspNet.Web.Optimization",
            "Microsoft.AspNet.WebApi.Core",
            "Microsoft.AspNet.WebApi.WebHost",
            "Microsoft.AspNet.WebPages",
            "Microsoft.CodeDom.Providers.DotNetCompilerPlatform",
            "Microsoft.Owin",
            "Microsoft.Owin.Host.SystemWeb",
            "Microsoft.Owin.Security",
            "Microsoft.Owin.Security.Cookies",
            "Microsoft.Owin.Security.OAuth",
            "Microsoft.Owin.Security.OpenIdConnect",
            "Microsoft.Web.Infrastructure",
            "Owin"
        );

        public static ImmutableDictionary<string, string> DefaultItemsThatHavePackageEquivalents => ImmutableDictionary.CreateRange(new Dictionary<string, string>
        {
            { "Microsoft.CSharp", "4.6.0" },
            { "Microsoft.VisualBasic", "10.3.0" },
            { "Microsoft.Win32.Registry.AccessControl", "4.6.0" },
            { "Microsoft.Win32.Registry", "4.6.0" },
            { "Microsoft.Win32.SystemEvents", "4.6.0" },
            { "System.CodeDom", "4.6.0" },
            { "System.ComponentModel.Composition.Registration", "4.6.0" },
            { "System.ComponentModel.Composition", "4.6.0" },
            { "System.ComponentModel.Annotations", "4.6.0" },
            { "System.ComponentModel.DataAnnotations", "4.6.0" },
            { "System.Configuration.ConfigurationManager", "4.6.0" },
            { "System.Data.DataSetExtensions", "4.5.0" },
            { "System.Data.Odbc", "4.6.0" },
            { "System.Data.OleDb", "4.6.0" },
            { "System.Data.SqlClient", "4.7.0" },
            { "System.Diagnostics.EventLog", "4.6.0" },
            { "System.Diagnostics.PerformanceCounter", "4.6.0" },
            { "System.DirectoryServices.AccountManagement", "4.6.0" },
            { "System.DirectoryServices.Protocols", "4.6.0" },
            { "System.DirectoryServices", "4.6.0" },
            { "System.Drawing.Common", "4.6.0" },
            { "System.IO.FileSystem.AccessControl", "4.6.0" },
            { "System.IO.Packaging", "4.6.0" },
            { "System.IO.Pipes.AccessControl", "4.5.1" },
            { "System.IO.Ports", "4.6.0" },
            { "System.Management", "4.6.0" },
            { "System.Reflection.Context", "4.6.0" },
            { "System.Reflection.Emit.ILGeneration", "4.6.0" },
            { "System.Reflection.Emit.Lightweight", "4.6.0" },
            { "System.Reflection.Emit", "4.6.0" },
            { "System.Runtime.Caching", "4.6.0" },
            { "System.Runtime.WindowsRuntime.UI.Xaml", "4.6.0" },
            { "System.Runtime.WindowsRuntime", "4.6.0" },
            { "System.Security.AccessControl", "4.6.0" },
            { "System.Security.Cryptography.Cng", "4.6.0" },
            { "System.Security.Cryptography.Pkcs", "4.6.0" },
            { "System.Security.Cryptography.ProtectedData", "4.6.0" },
            { "System.Security.Cryptography.Xml", "4.6.0" },
            { "System.Security.Permissions", "4.6.0" },
            { "System.Security.Principal.Windows", "4.6.0" },
            { "System.ServiceModel.Duplex", "4.5.3" },
            { "System.ServiceModel.Http", "4.5.3" },
            { "System.ServiceModel.NetTcp", "4.5.3" },
            { "System.ServiceModel.Primitives", "4.5.3" },
            { "System.ServiceModel.Security", "4.5.3" },
            { "System.ServiceModel.Syndication", "4.6.0" },
            { "System.ServiceProcess.ServiceController", "4.6.0" },
            { "System.Text.Encoding.CodePages", "4.6.0" },
            { "System.Threading.AccessControl", "4.6.0" },
        });

        public static ImmutableArray<string> ItemsThatCanHaveMetadataRemoved => ImmutableArray.Create(
            "ProjectReference"
        );

        public static Guid LanguageProjectTypeVisualBasic => Guid.Parse("{F184B08F-C81C-45F6-A57F-5ABD9991F28F}");

        public static ImmutableArray<Guid> LanguageProjectTypeGuids => ImmutableArray.Create(
            Guid.Parse("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}"), // C#
            LanguageProjectTypeVisualBasic, // VB.NET
            Guid.Parse("{F2A71F9B-5D33-465A-A702-920D77279786}") // F#
        );

        public static readonly (string Name, string Version) CsWinRTPackageReference = (Name: "Microsoft.Windows.CsWinRT", Version: "1.6.4");

        public const string DefaultSDKAttribute = "Microsoft.NET.Sdk";
        public const string LowestFrameworkVersionWithSystemValueTuple = "net47";
        public const string SharedProjectsImportLabel = "Shared";
        public const string SystemValueTupleName = "System.ValueTuple";
        public const string DefineConstantsName = "DefineConstants";
        public const string OutputPathName = "OutputPath";
        public const string DebugTypeName = "DebugType";
        public const string SubTypeNodeName = "SubType";
        public const string DependentUponName = "DependentUpon";
        public const string PlatformTargetName = "PlatformTarget";
        public const string NetcoreappPrelude = "netcoreapp";
        public const string NetstandardPrelude = "netstandard";
        public const string MSBuildReferenceName = "Reference";
        public const string MSBuildPackageReferenceName = "PackageReference";
        public const string DesignerSubType = "Designer";
        public const string CodeSubTypeValue = "Code";
        public const string TargetFrameworkNodeName = "TargetFramework";
        public const string OutputTypeNodeName = "OutputType";
        public const string GenerateAssemblyInfoNodeName = "GenerateAssemblyInfo";
        public const string RequiredTargetFrameworkNodeName = "RequiredTargetFramework";
        public const string NameNodeName = "Name";
        public const string DocumentationFileNodeName = "DocumentationFile";
        public const string DefaultDocumentationFileLocation = @"bin\$(Configuration)\$(AssemblyName).XML";
        public const string CSharpFileSuffix = ".cs";
        public const string ProjectTypeGuidsNodeName = "ProjectTypeGuids";
        public const string HintPathNodeName = "HintPath";
        public const string SystemWebReferenceName = "System.Web";
        public const string LibraryOutputType = "Library";
        public const string ExeOutputType = "Exe";
        public const string WinExeOutputType = "WinExe";
        public const string AppContainerExeOutputType = "AppContainerExe";
        public const string WinMdObjOutputType = "winmdobj";
        public const string NuGetPackageImportStampNodeName = "NuGetPackageImportStamp";
        public const string ReferencePathNodeName = "ReferencePath";
        public const string LegacyTargetFrameworkPropertyNodeName = "TargetFrameworkIdentifier";
        public const string LegacyTargetFrameworkVersionNodeName = "TargetFrameworkVersion";
        public const string LegacyTargetFrameworkProfileNodeName = "TargetFrameworkProfile";
        public const string NETPortableTFValuePrefix = ".NETPortable";
        public const string PCLv5value = "v5.0";
        public const string TargetsSuffix = ".targets";
        public const string PropsSuffix = ".props";
        public const string PackagesSubstring = @"\packages";
        public const string NetStandard20 = "netstandard2.0";
        public const string NetCoreApp31 = "netcoreapp3.1";
        public const string Net5 = "net5.0";
        public const string WindowsSuffix = "-windows";
        public const string Net5Windows = "net5.0-windows";
        public const string Net6 = "net6.0";
        public const string Net6Windows = "net6.0-windows";
        public const string AppConfig = "App.config";
        public const string EmbeddedResourceGeneratorProperty = "Generator";
        public const string SettingsSingleFileGenerator = "SettingsSingleFileGenerator";
        public const string TargetPlatformIdentifierNodeName = "TargetPlatformIdentifier";
        public const string UapValue = "UAP";
        public const string TargetPlatformVersionNodeName = "TargetPlatformVersion";
        public const string CsWinRTComponentName = "CsWinRTComponent";
    }
}