Merged PR 474132: Update support for dotnet.defaultSolution to recognize 'disable' and other tweaks

- Update the message for dotnet.defaultSolution to match the Dev Kit one
- Remove order: 0 for options that should only be set by extension developers
- Make the "useOmnisharp" option order first
- Update support for dotnet.defaultSolution to recognize 'disable'

Author: jasonmalinowski

package.json

@@ -714,7 +714,8 @@
           "dotnet.server.useOmnisharp": {
             "type": "boolean",
             "default": false,
-            "description": "Switches to use the Omnisharp server for language features when enabled (requires restart). This option will not work with C# Dev Kit"
+            "description": "Switches to use the Omnisharp server for language features when enabled (requires restart). This option will not work with C# Dev Kit.",
+            "order": 0
           },
           "csharp.format.enable": {
             "type": "boolean",
@@ -1146,26 +1147,24 @@
         "properties": {
           "dotnet.defaultSolution": {
             "type": "string",
-            "description": "The name of the default solution used at start up if the repo has multiple solutions. e.g.'MyAwesomeSolution.sln'. Default value is `null` which will cause the first in alphabetical order to be chosen."
+            "description": "The path of the default solution to be opened in the workspace, or set to 'disable' to skip it.",
+            "order": 0
           },
           "dotnet.dotnetPath": {
             "type": "string",
             "scope": "machine-overridable",
-            "description": "Specified the path to a dotnet installation to use instead of the default system one. This only influences the dotnet installation to use for hosting the language server itself. Example: \"/home/username/mycustomdotnetdirectory\".",
-            "order": 0
+            "description": "Specified the path to a dotnet installation to use instead of the default system one. This only influences the dotnet installation to use for hosting the language server itself. Example: \"/home/username/mycustomdotnetdirectory\"."
           },
           "dotnet.server.path": {
             "type": "string",
             "scope": "machine-overridable",
-            "description": "Specifies the absolute path to the server (LSP or O#) executable. When left empty the version pinned to the C# Extension is used.",
-            "order": 0
+            "description": "Specifies the absolute path to the server (LSP or O#) executable. When left empty the version pinned to the C# Extension is used."
           },
           "dotnet.server.waitForDebugger": {
             "type": "boolean",
             "scope": "machine-overridable",
             "default": false,
-            "description": "Passes the --debug flag when launching the server to allow a debugger to be attached.",
-            "order": 0
+            "description": "Passes the --debug flag when launching the server to allow a debugger to be attached."
           },
           "dotnet.server.trace": {
             "scope": "window",
@@ -1180,8 +1179,7 @@
               "None"
             ],
             "default": "Information",
-            "description": "Sets the logging level for the language server",
-            "order": 0
+            "description": "Sets the logging level for the language server"
           },
           "dotnet.server.extensionPaths": {
             "type": [

src/lsptoolshost/roslynLanguageServer.ts

@@ -217,13 +217,13 @@ export class RoslynLanguageServer {
         // Register Razor dynamic file info handling
         this.registerRazor(this._languageClient);
 
-        // If Dev Kit isn't installed, then we are responsible for picking the solution to open. Check the workpace setting,
-        // or fallback to looking for a solution
-        if (!this._wasActivatedWithCSharpDevkit) {
-            if (this._solutionFile === undefined && options.commonOptions.defaultSolution !== '') {
+        // If Dev Kit isn't installed, then we are responsible for picking the solution to open, assuming the user hasn't explicitly
+        // disabled it.
+        if (!this._wasActivatedWithCSharpDevkit && options.commonOptions.defaultSolution !== 'disable' && this._solutionFile === undefined) {
+            if (options.commonOptions.defaultSolution !== '') {
                 this.openSolution(vscode.Uri.file(options.commonOptions.defaultSolution));
             } else {
-                // Auto open if there is just one solution target, if not the let the user trigger an open solution themselves
+                // Auto open if there is just one solution target; if there's more the one we'll just let the user pick with the picker.
                 const solutionUris = await vscode.workspace.findFiles('**/*.sln', '**/node_modules/**', 2);
                 if (solutionUris && solutionUris.length === 1) {
                     this.openSolution(solutionUris[0]);

src/shared/options.ts

@@ -38,25 +38,31 @@ export class Options {
 
         let defaultSolution = '';
 
-        if (vscode.workspace.workspaceFolders !== undefined) {
-            // If this is multi-folder, then check to see if we have a fully qualified path set directly in the workspace settings; this will let the user directly specify in their
-            // workspace settings which one is active in the case of a multi-folder workspace. This has to be absolute because in this case, there's no clear folder to resolve a relative
-            // path against.
-            if (vscode.workspace.workspaceFolders.length > 1) {
-                const defaultSolutionFromWorkspace = Options.readOption<string>(config, 'dotnet.defaultSolution', '', 'omnisharp.defaultLaunchSolution');
-                if (path.isAbsolute(defaultSolutionFromWorkspace)) {
-                    defaultSolution = defaultSolutionFromWorkspace;
+        const defaultSolutionFromWorkspace = Options.readOption<string>(config, 'dotnet.defaultSolution', '', 'omnisharp.defaultLaunchSolution');
+
+        // If the workspace has defaultSolution disabled, just be done
+        if (defaultSolutionFromWorkspace === "disable") {
+            defaultSolution = "disable";
+        } else {
+            if (vscode.workspace.workspaceFolders !== undefined) {
+                // If this is multi-folder, then check to see if we have a fully qualified path set directly in the workspace settings; this will let the user directly specify in their
+                // workspace settings which one is active in the case of a multi-folder workspace. This has to be absolute because in this case, there's no clear folder to resolve a relative
+                // path against.
+                if (vscode.workspace.workspaceFolders.length > 1) {
+                    if (path.isAbsolute(defaultSolutionFromWorkspace)) {
+                        defaultSolution = defaultSolutionFromWorkspace;
+                    }
                 }
-            }
 
-            // If we didn't have an absolute workspace setting, then check each workspace folder and resolve any relative paths against it
-            if(defaultSolution == '') {
-                for (let workspaceFolder of vscode.workspace.workspaceFolders) {
-                    const workspaceFolderConfig = vscode.workspace.getConfiguration(undefined, workspaceFolder.uri);
-                    const defaultSolutionFromWorkspaceFolder = Options.readOption<string>(workspaceFolderConfig, 'dotnet.defaultSolution', '', 'omnisharp.defaultLaunchSolution');
-                    if (defaultSolutionFromWorkspaceFolder !== '') {
-                        defaultSolution = path.join(workspaceFolder.uri.fsPath, defaultSolutionFromWorkspaceFolder);
-                        break;
+                // If we didn't have an absolute workspace setting, then check each workspace folder and resolve any relative paths against it
+                if(defaultSolution == '') {
+                    for (let workspaceFolder of vscode.workspace.workspaceFolders) {
+                        const workspaceFolderConfig = vscode.workspace.getConfiguration(undefined, workspaceFolder.uri);
+                        const defaultSolutionFromWorkspaceFolder = Options.readOption<string>(workspaceFolderConfig, 'dotnet.defaultSolution', '', 'omnisharp.defaultLaunchSolution');
+                        if (defaultSolutionFromWorkspaceFolder !== '' && defaultSolutionFromWorkspaceFolder !== "disable") {
+                            defaultSolution = path.join(workspaceFolder.uri.fsPath, defaultSolutionFromWorkspaceFolder);
+                            break;
+                        }
                     }
                 }
             }
@@ -251,7 +257,7 @@ export interface CommonOptions {
     useOmnisharpServer: boolean;
     excludePaths: string[];
 
-    /** The default solution; this has been normalized to a full file path from the workspace folder it was configured in */
+    /** The default solution; this has been normalized to a full file path from the workspace folder it was configured in, or the string "disable" if that has been disabled */
     defaultSolution: string;
 }