Merge pull request #2053 from janaka/config-default-sln

Add support for configuring default startup *.sln in settings.json

Author: akshita31

.gitignore

@@ -10,9 +10,10 @@ install.*
 
 *.vsix
 
-obj/
-bin/
-test/**/.vscode
+
+test/**/.vscode/launch.json
+test/**/.vscode/tasks.json
+
 .logs/
 .nyc_output/
 coverage/

.vscode/tasks.json

@@ -5,7 +5,10 @@
 			"taskName": "build",
 			"command": "npm",
 			"isShellCommand": true,
-			"args": ["run", "compile"],
+			"args": [
+				"run",
+				"compile"
+			],
 			"showOutput": "always",
 			"isBuildCommand": true
 		},
@@ -14,19 +17,23 @@
 			"command": "echo",
 			"showOutput": "always",
 			"isShellCommand": true,
-			"args": ["Run tests in VS Code by launching the debugger with the 'Launch Tests' configuration."],
+			"args": [
+				"Run tests in VS Code by launching the debugger with the 'Launch Tests' configuration."
+			],
 			"isTestCommand": true
 		},
 		{
 			"taskName": "tslint",
 			"command": "gulp",
 			"isShellCommand": true,
-			"args": ["tslint"],
+			"args": [
+				"tslint"
+			],
 			"problemMatcher": {
 				"owner": "tslint",
 				"fileLocation": [
 					"relative",
-					"${workspaceRoot}"
+					"${workspaceFolder}"
 				],
 				"severity": "warning",
 				"pattern": {

CHANGELOG.md

@@ -11,11 +11,14 @@
   * "Restore Project" - Displays a drop-down that shows all the available projects in the solution or in the workspace. Selecting one of them would trigger a dotnet restore for the particular project.
   * "Restore All Projects" - Triggers a dotnet restore for all projects in the current solution or workspace.
 
-* Modified the "Unresolved dependencies" prompt to restore the all the projects in the currently selected solution or workspace. (PR: [#2323] https://github.com/OmniSharp/omnisharp-vscode/pull/2323)
+* Modified the "Unresolved dependencies" prompt to restore the all the projects in the currently selected solution or workspace. (PR: [#2323](https://github.com/OmniSharp/omnisharp-vscode/pull/2323))
+
+* Added support to configure the default *.sln file loaded when opening a project with multiple *.sln files in the root. _(Contributed by [@janaka](https://github.com/janaka))_ (PR: [#2053](https://github.com/OmniSharp/omnisharp-vscode/pull/2053)) 
+
 
 #### Misc
 
-* Added a prompt to "Restart OmniSharp" when there is a change in omnisharp "path", "useGlobalMono" or "waitForDebugger" settings.(PR: [#2316] https://github.com/OmniSharp/omnisharp-vscode/pull/2316)
+* Added a prompt to "Restart OmniSharp" when there is a change in omnisharp "path", "useGlobalMono" or "waitForDebugger" settings.(PR: [#2316](https://github.com/OmniSharp/omnisharp-vscode/pull/2316))
 
 #### Editor
 

package.json

@@ -568,6 +568,11 @@
           "default": 250,
           "description": "The maximum number of projects to be shown in the 'Select Project' dropdown (maximum 250)."
         },
+        "omnisharp.defaultLaunchSolution": {
+          "type": "string",
+          "default": null,
+          "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."
+        },
         "omnisharp.useEditorFormattingSettings": {
           "type": "boolean",
           "default": true,
@@ -1618,9 +1623,9 @@
               "type": "coreclr",
               "request": "launch",
               "preLaunchTask": "build",
-              "program": "^\"\\${workspaceRoot}/bin/Debug/${1:<target-framework>}/${2:<project-name.dll>}\"",
+              "program": "^\"\\${workspaceFolder}/bin/Debug/${1:<target-framework>}/${2:<project-name.dll>}\"",
               "args": [],
-              "cwd": "^\"\\${workspaceRoot}\"",
+              "cwd": "^\"\\${workspaceFolder}\"",
               "stopAtEntry": false,
               "console": "internalConsole"
             }
@@ -1643,9 +1648,9 @@
               "type": "coreclr",
               "request": "launch",
               "preLaunchTask": "build",
-              "program": "^\"\\${workspaceRoot}/bin/Debug/${1:<target-framework>}/${2:<project-name.dll>}\"",
+              "program": "^\"\\${workspaceFolder}/bin/Debug/${1:<target-framework>}/${2:<project-name.dll>}\"",
               "args": [],
-              "cwd": "^\"\\${workspaceRoot}\"",
+              "cwd": "^\"\\${workspaceFolder}\"",
               "stopAtEntry": false,
               "launchBrowser": {
                 "enabled": true,
@@ -1665,7 +1670,7 @@
                 "ASPNETCORE_ENVIRONMENT": "Development"
               },
               "sourceFileMap": {
-                "/Views": "^\"\\${workspaceRoot}/Views\""
+                "/Views": "^\"\\${workspaceFolder}/Views\""
               }
             }
           },
@@ -1677,13 +1682,13 @@
               "type": "coreclr",
               "request": "launch",
               "preLaunchTask": "build",
-              "program": "^\"\\${workspaceRoot}/bin/Debug/${1:<target-framework>}/${2:<project-name.dll>}\"",
+              "program": "^\"\\${workspaceFolder}/bin/Debug/${1:<target-framework>}/${2:<project-name.dll>}\"",
               "args": [],
-              "cwd": "^\"\\${workspaceRoot}\"",
+              "cwd": "^\"\\${workspaceFolder}\"",
               "stopAtEntry": false,
               "console": "internalConsole",
               "pipeTransport": {
-                "pipeCwd": "^\"\\${workspaceRoot}\"",
+                "pipeCwd": "^\"\\${workspaceFolder}\"",
                 "pipeProgram": "^\"${3:enter the fully qualified path for the pipe program name, for example '/usr/bin/ssh'}\"",
                 "pipeArgs": [],
                 "debuggerPath": "^\"${4:enter the path for the debugger on the target machine, for example ~/vsdbg/vsdbg}\""
@@ -1699,7 +1704,7 @@
               "request": "attach",
               "processId": "^\"\\${command:pickRemoteProcess}\"",
               "pipeTransport": {
-                "pipeCwd": "^\"\\${workspaceRoot}\"",
+                "pipeCwd": "^\"\\${workspaceFolder}\"",
                 "pipeProgram": "^\"${1:enter the fully qualified path for the pipe program name, for example '/usr/bin/ssh'}\"",
                 "pipeArgs": [],
                 "debuggerPath": "^\"${2:enter the path for the debugger on the target machine, for example ~/vsdbg/vsdbg}\""

src/omnisharp/launcher.ts

@@ -101,7 +101,6 @@ function resourcesToLaunchTargets(resources: vscode.Uri[]): LaunchTarget[] {
             // Add .sln files if there are .csproj files
             if (hasCsProjFiles && isSolution(resource)) {
                 hasSlnFile = true;
-
                 targets.push({
                     label: path.basename(resource.fsPath),
                     description: vscode.workspace.asRelativePath(path.dirname(resource.fsPath)),

src/omnisharp/options.ts

@@ -19,7 +19,9 @@ export class Options {
         public showReferencesCodeLens: boolean,
         public showTestsCodeLens: boolean,
         public disableCodeActions: boolean,
-        public disableMSBuildDiagnosticWarning: boolean) { }
+        public disableMSBuildDiagnosticWarning: boolean,
+        public defaultLaunchSolution?: string) { }
+        
 
     public static Read(vscode: vscode): Options {
         // Extra effort is taken below to ensure that legacy versions of options
@@ -47,6 +49,7 @@ export class Options {
 
         const projectLoadTimeout = omnisharpConfig.get<number>('projectLoadTimeout', 60);
         const maxProjectResults = omnisharpConfig.get<number>('maxProjectResults', 250);
+        const defaultLaunchSolution = omnisharpConfig.get<string>('defaultLaunchSolution', undefined);
         const useEditorFormattingSettings = omnisharpConfig.get<boolean>('useEditorFormattingSettings', true);
 
         const useFormatting = csharpConfig.get<boolean>('format.enable', true);
@@ -62,16 +65,17 @@ export class Options {
             path, 
             useGlobalMono, 
             waitForDebugger,
-            loggingLevel, 
-            autoStart, 
-            projectLoadTimeout, 
-            maxProjectResults, 
-            useEditorFormattingSettings, 
+            loggingLevel,
+            autoStart,
+            projectLoadTimeout,
+            maxProjectResults,
+            useEditorFormattingSettings,
             useFormatting,
             showReferencesCodeLens,
             showTestsCodeLens,
             disableCodeActions,
-            disableMSBuildDiagnosticWarning);
+            disableMSBuildDiagnosticWarning,
+            defaultLaunchSolution);
     }
 
     private static readPathOption(csharpConfig: WorkspaceConfiguration, omnisharpConfig: WorkspaceConfiguration): string | null {

src/omnisharp/server.ts

@@ -445,6 +445,14 @@ export class OmniSharpServer {
                 });
             }
 
+            const defaultLaunchSolutionConfigValue = this.optionProvider.GetLatestOptions().defaultLaunchSolution;
+
+            // First, try to launch against something that matches the user's preferred target
+            const defaultLaunchSolutionTarget = launchTargets.find((a) => (path.basename(a.target) === defaultLaunchSolutionConfigValue));
+            if (defaultLaunchSolutionTarget) {
+                return this.restart(defaultLaunchSolutionTarget);
+            }
+
             // If there's more than one launch target, we start the server if one of the targets
             // matches the preferred path. Otherwise, we fire the "MultipleLaunchTargets" event,
             // which is handled in status.ts to display the launch target selector.

test/integrationTests/testAssets/singleCsproj/.gitignore

@@ -0,0 +1,2 @@
+**/obj/
+**/bin/