Enable per-workspace override of MSBuildExtensionsPath.

Submitted by @Brembow34, merged by @tintoy

tintoy/msbuild-project-tools-vscode#35

src/LanguageServer.Common/Utilities/MSBuildHelper.cs

@@ -37,13 +37,17 @@ public static class MSBuildHelper
         /// <param name="solutionDirectory">
         ///     The base (i.e. solution) directory.
         /// </param>
+        /// <param name="globalPropertyOverrides">
+        ///     An optional dictionary containing property values to override.
+        /// </param>
         /// <returns>
         ///     The project collection.
         /// </returns>
-        public static ProjectCollection CreateProjectCollection(string solutionDirectory)
+        public static ProjectCollection CreateProjectCollection(string solutionDirectory, Dictionary<string, string> globalPropertyOverrides = null)
         {
             return CreateProjectCollection(solutionDirectory,
-                DotNetRuntimeInfo.GetCurrent(solutionDirectory)
+                DotNetRuntimeInfo.GetCurrent(solutionDirectory),
+                globalPropertyOverrides
             );
         }
 
@@ -56,10 +60,13 @@ public static ProjectCollection CreateProjectCollection(string solutionDirectory
         /// <param name="runtimeInfo">
         ///     Information about the current .NET Core runtime.
         /// </param>
+        /// <param name="globalPropertyOverrides">
+        ///     An optional dictionary containing property values to override.
+        /// </param>
         /// <returns>
         ///     The project collection.
         /// </returns>
-        public static ProjectCollection CreateProjectCollection(string solutionDirectory, DotNetRuntimeInfo runtimeInfo)
+        public static ProjectCollection CreateProjectCollection(string solutionDirectory, DotNetRuntimeInfo runtimeInfo, Dictionary<string, string> globalPropertyOverrides = null)
         {
             if (String.IsNullOrWhiteSpace(solutionDirectory))
                 throw new ArgumentException("Argument cannot be null, empty, or entirely composed of whitespace: 'baseDir'.", nameof(solutionDirectory));
@@ -70,7 +77,7 @@ public static ProjectCollection CreateProjectCollection(string solutionDirectory
             if (String.IsNullOrWhiteSpace(runtimeInfo.BaseDirectory))
                 throw new InvalidOperationException("Cannot determine base directory for .NET Core (check the output of 'dotnet --info').");
 
-            Dictionary<string, string> globalProperties = CreateGlobalMSBuildProperties(runtimeInfo, solutionDirectory);
+            Dictionary<string, string> globalProperties = CreateGlobalMSBuildProperties(runtimeInfo, solutionDirectory, globalPropertyOverrides);
             EnsureMSBuildEnvironment(globalProperties);
 
             ProjectCollection projectCollection = new ProjectCollection(globalProperties) { IsBuildEnabled = false };
@@ -79,7 +86,7 @@ public static ProjectCollection CreateProjectCollection(string solutionDirectory
             Toolset toolset = projectCollection.GetToolset("15.0");
             toolset = new Toolset(
                 toolsVersion: "15.0",
-                toolsPath: globalProperties["MSBuildExtensionsPath"],
+                toolsPath: runtimeInfo.BaseDirectory,
                 projectCollection: projectCollection,
                 msbuildOverrideTasksPath: ""
             );
@@ -97,10 +104,13 @@ public static ProjectCollection CreateProjectCollection(string solutionDirectory
         /// <param name="solutionDirectory">
         ///     The base (i.e. solution) directory.
         /// </param>
+        /// <param name="globalPropertyOverrides">
+        ///     An optional dictionary containing property values to override.
+        /// </param>
         /// <returns>
         ///     A dictionary containing the global properties.
         /// </returns>
-        public static Dictionary<string, string> CreateGlobalMSBuildProperties(DotNetRuntimeInfo runtimeInfo, string solutionDirectory)
+        public static Dictionary<string, string> CreateGlobalMSBuildProperties(DotNetRuntimeInfo runtimeInfo, string solutionDirectory, Dictionary<string, string> globalPropertyOverrides = null)
         {
             if (runtimeInfo == null)
                 throw new ArgumentNullException(nameof(runtimeInfo));
@@ -116,7 +126,7 @@ public static Dictionary<string, string> CreateGlobalMSBuildProperties(DotNetRun
             if (String.IsNullOrWhiteSpace(sdksPath))
                 sdksPath = Path.Combine(runtimeInfo.BaseDirectory, "Sdks");
 
-            return new Dictionary<string, string>
+            var globalProperties = new Dictionary<string, string>
             {
                 [WellKnownPropertyNames.DesignTimeBuild] = "true",
                 [WellKnownPropertyNames.BuildProjectReferences] = "false",
@@ -126,6 +136,14 @@ public static Dictionary<string, string> CreateGlobalMSBuildProperties(DotNetRun
                 [WellKnownPropertyNames.MSBuildSDKsPath] = sdksPath,
                 [WellKnownPropertyNames.RoslynTargetsPath] = Path.Combine(runtimeInfo.BaseDirectory, "Roslyn")
             };
+
+            if (globalPropertyOverrides != null)
+            {
+                foreach (string propertyName in globalPropertyOverrides.Keys)
+                    globalProperties[propertyName] = globalPropertyOverrides[propertyName];
+            }
+
+            return globalProperties;
         }
 
         /// <summary>
@@ -230,11 +248,21 @@ public static class WellKnownPropertyNames
             /// </summary>
             public static readonly string MSBuildExtensionsPath = "MSBuildExtensionsPath";
 
+            /// <summary>
+            ///     The "MSBuildExtensionsPath32" property.
+            /// </summary>
+            public static readonly string MSBuildExtensionsPath32 = "MSBuildExtensionsPath32";
+
             /// <summary>
             ///     The "MSBuildSDKsPath" property.
             /// </summary>
             public static readonly string MSBuildSDKsPath = "MSBuildSDKsPath";
 
+            /// <summary>
+            ///     The "MSBuildToolsPath" property.
+            /// </summary>
+            public static readonly string MSBuildToolsPath = "MSBuildToolsPath";
+
             /// <summary>
             ///     The "SolutionDir" property.
             /// </summary>

src/LanguageServer.Engine/Configuration.cs

@@ -36,6 +36,12 @@ public Configuration()
         /// </summary>
         [JsonProperty("language", ObjectCreationHandling = ObjectCreationHandling.Reuse)]
         public LanguageConfiguration Language { get; } = new LanguageConfiguration();
+
+        /// <summary>
+        ///     The MSBuild language service's MSBuild engine configuration.
+        /// </summary>
+        [JsonProperty("msbuild", ObjectCreationHandling = ObjectCreationHandling.Reuse)]
+        public MSBuildConfiguration MSBuild { get; } = new MSBuildConfiguration();
 
         /// <summary>
         ///     The MSBuild language service's NuGet configuration.
@@ -162,6 +168,31 @@ public LanguageConfiguration()
         public HashSet<CompletionSource> CompletionsFromProject { get; } = new HashSet<CompletionSource>();
     }
 
+    /// <summary>
+    ///     Configuration for the MSBuild engine.
+    /// </summary>
+    public class MSBuildConfiguration
+    {
+        /// <summary>
+        ///     Create a new <see cref="MSBuildConfiguration"/>.
+        /// </summary>
+        public MSBuildConfiguration()
+        {
+        }
+
+        /// <summary>
+        ///     Override the default value of MSBuildExtensionsPath.
+        /// </summary>
+        [JsonProperty("extensionsPath")]
+        public string ExtensionsPath { get; set; }
+
+        /// <summary>
+        ///     Override the default value of MSBuildExtensionsPath32.
+        /// </summary>
+        [JsonProperty("extensionsPath32")]
+        public string ExtensionsPath32 { get; set; }
+    }
+
     /// <summary>
     ///     Configuration for disabled language-service features.
     /// </summary>

src/LanguageServer.Engine/Documents/MasterProjectDocument.cs

@@ -148,7 +148,11 @@ protected override bool TryLoadMSBuildProject()
                     return true;
 
                 if (MSBuildProjectCollection == null)
-                    MSBuildProjectCollection = MSBuildHelper.CreateProjectCollection(ProjectFile.Directory.FullName);
+                {
+                    MSBuildProjectCollection = MSBuildHelper.CreateProjectCollection(ProjectFile.Directory.FullName,
+                        globalPropertyOverrides: GetMSBuildGlobalPropertyOverrides()
+                    );
+                }
 
                 if (HasMSBuildProject && IsDirty)
                 {

src/LanguageServer.Engine/Documents/ProjectDocument.cs

@@ -664,6 +664,20 @@ public Range GetRange(ExpressionNode expression, Position relativeToPosition)
             return metadata;
         }
 
+        /// <summary>
+        ///     Get overrides (if any) for MSBuild global properties.
+        /// </summary>
+        protected virtual Dictionary<string, string> GetMSBuildGlobalPropertyOverrides()
+        {
+            var propertyOverrides = new Dictionary<string, string>();
+            if (!String.IsNullOrWhiteSpace(Workspace.Configuration.MSBuild.ExtensionsPath))
+                propertyOverrides[MSBuildHelper.WellKnownPropertyNames.MSBuildExtensionsPath] = Workspace.Configuration.MSBuild.ExtensionsPath;
+            if (!String.IsNullOrWhiteSpace(Workspace.Configuration.MSBuild.ExtensionsPath32))
+                propertyOverrides[MSBuildHelper.WellKnownPropertyNames.MSBuildExtensionsPath32] = Workspace.Configuration.MSBuild.ExtensionsPath32;
+
+            return propertyOverrides;
+        }
+
         /// <summary>
         ///     Attempt to load the underlying MSBuild project.
         /// </summary>