Merge pull request #4481 from JoeRobich/solution-filters

Support solution filters (*.slnf)

Author: JoeRobich

.vscode/launch.json

@@ -128,6 +128,31 @@
             ],
             "preLaunchTask": "buildDev"
         },
+        {
+            "name": "Launch slnFilterWithCsproj Workspace Tests",
+            "type": "extensionHost",
+            "request": "launch",
+            "runtimeExecutable": "${execPath}",
+            "args": [
+                "--disable-extensions",
+                "${workspaceRoot}/test/integrationTests/testAssets/slnFilterWithCsproj",
+                "--extensionDevelopmentPath=${workspaceRoot}",
+                "--extensionTestsPath=${workspaceRoot}/out/test/integrationTests"
+            ],
+            "env": {
+                "CODE_WORKSPACE_ROOT": "${workspaceRoot}",
+                "CODE_TESTS_PATH": "${workspaceRoot}/out/test/integrationTests",
+                "CODE_TESTS_WORKSPACE": "${workspaceRoot}/test/integrationTests/testAssets/slnFilterWithCsproj",
+                "CODE_EXTENSIONS_PATH": "${workspaceRoot}",
+                "OSVC_SUITE": "slnFilterWithCsproj"
+            },
+            "stopOnEntry": false,
+            "sourceMaps": true,
+            "outFiles": [
+                "${workspaceRoot}/dist/*.js"
+            ],
+            "preLaunchTask": "buildDev"
+        },
         {
             "type": "node",
             "request": "launch",

package.json

@@ -45,6 +45,7 @@
     "test:integration": "gulp test:integration",
     "test:integration:singleCsproj": "gulp test:integration:singleCsproj",
     "test:integration:slnWithCsproj": "gulp test:integration:slnWithCsproj",
+    "test:integration:slnFilterWithCsproj": "gulp test:integration:slnFilterWithCsproj",
     "test:release": "mocha --config ./.mocharc.jsonc test/releaseTests/**/*.test.ts",
     "test:artifacts": "mocha --config ./.mocharc.jsonc test/artifactTests/**/*.test.ts",
     "postinstall": "node ./node_modules/vscode/bin/install",
@@ -409,10 +410,12 @@
     "workspaceContains:project.json",
     "workspaceContains:*.csproj",
     "workspaceContains:*.sln",
+    "workspaceContains:*.slnf",
     "workspaceContains:*.csx",
     "workspaceContains:*.cake",
     "workspaceContains:**/*.csproj",
     "workspaceContains:**/*.sln",
+    "workspaceContains:**/*.slnf",
     "workspaceContains:**/*.csx",
     "workspaceContains:**/*.cake"
   ],

src/configurationProvider.ts

@@ -40,7 +40,7 @@ export class CSharpConfigurationProvider implements vscode.DebugConfigurationPro
         }
 
         let serverFolder = solutionPathOrFolder;
-        // If its a .sln file, get the folder of the solution.
+        // If its a .sln or .slnf file, get the folder of the solution.
         return fs.lstat(solutionPathOrFolder).then(stat => {
             return stat.isFile();
         }).then(isFile => {

src/omnisharp/launcher.ts

@@ -52,17 +52,17 @@ export const disabledSchemes = new Set([
 
 /**
  * Returns a list of potential targets on which OmniSharp can be launched.
- * This includes `project.json` files, `*.sln` files (if any `*.csproj` files are found), and the root folder
+ * This includes `project.json` files, `*.sln` and `*.slnf` files (if any `*.csproj` files are found), and the root folder
  * (if it doesn't contain a `project.json` file, but `project.json` files exist). In addition, the root folder
- * is included if there are any `*.csproj` files present, but a `*.sln* file is not found.
+ * is included if there are any `*.csproj` files present, but a `*.sln` or `*.slnf` file is not found.
  */
 export async function findLaunchTargets(options: Options): Promise<LaunchTarget[]> {
     if (!vscode.workspace.workspaceFolders) {
         return Promise.resolve([]);
     }
 
     const projectFiles = await vscode.workspace.findFiles(
-        /*include*/ '{**/*.sln,**/*.csproj,**/project.json,**/*.csx,**/*.cake}',
+        /*include*/ '{**/*.sln,**/*.slnf,**/*.csproj,**/project.json,**/*.csx,**/*.cake}',
         /*exclude*/ '{**/node_modules/**,**/.git/**,**/bower_components/**}',
         /*maxResults*/ options.maxProjectResults);
 
@@ -76,14 +76,14 @@ export async function findLaunchTargets(options: Options): Promise<LaunchTarget[
 
 export function resourcesToLaunchTargets(resources: vscode.Uri[]): LaunchTarget[] {
     // The list of launch targets is calculated like so:
-    //   * If there are .csproj files, .sln files are considered as launch targets.
+    //   * If there are .csproj files, .sln and .slnf files are considered as launch targets.
     //   * Any project.json file is considered a launch target.
     //   * If there is no project.json file in a workspace folder, the workspace folder as added as a launch target.
-    //   * Additionally, if there are .csproj files, but no .sln file, the root is added as a launch target.
+    //   * Additionally, if there are .csproj files, but no .sln or .slnf file, the root is added as a launch target.
     //
     // TODO:
     //   * It should be possible to choose a .csproj as a launch target
-    //   * It should be possible to choose a .sln file even when no .csproj files are found
+    //   * It should be possible to choose a .sln or .slnf file even when no .csproj files are found
     //     within the root.
 
     if (!Array.isArray(resources) || resources.length === 0) {
@@ -132,7 +132,7 @@ export function resourcesToLaunchTargets(resources: vscode.Uri[]): LaunchTarget[
         let folderPath = folder.uri.fsPath;
 
         resources.forEach(resource => {
-            // Add .sln files if there are .csproj files
+            // Add .sln and .slnf files if there are .csproj files
             if (hasCsProjFiles && isSolution(resource)) {
                 hasSlnFile = true;
                 targets.push({
@@ -176,7 +176,7 @@ export function resourcesToLaunchTargets(resources: vscode.Uri[]): LaunchTarget[
         });
 
         // Add the root folder under the following circumstances:
-        // * If there are .csproj files, but no .sln file, and none in the root.
+        // * If there are .csproj files, but no .sln or .slnf file, and none in the root.
         // * If there are project.json files, but none in the root.
         if ((hasCsProjFiles && !hasSlnFile) || (hasProjectJson && !hasProjectJsonAtRoot)) {
             targets.push({
@@ -229,7 +229,7 @@ function isCSharpProject(resource: vscode.Uri): boolean {
 }
 
 function isSolution(resource: vscode.Uri): boolean {
-    return /\.sln$/i.test(resource.fsPath);
+    return /\.slnf?$/i.test(resource.fsPath);
 }
 
 function isProjectJson(resource: vscode.Uri): boolean {

src/omnisharp/server.ts

@@ -498,11 +498,11 @@ export class OmniSharpServer {
         const options = this.optionProvider.GetLatestOptions();
         return findLaunchTargets(options).then(async launchTargets => {
             // If there aren't any potential launch targets, we create file watcher and try to
-            // start the server again once a *.sln, *.csproj, project.json, CSX or Cake file is created.
+            // start the server again once a *.sln, *.slnf, *.csproj, project.json, CSX or Cake file is created.
             if (launchTargets.length === 0) {
                 return new Promise<void>((resolve, reject) => {
                     // 1st watch for files
-                    let watcher = this.vscode.workspace.createFileSystemWatcher('{**/*.sln,**/*.csproj,**/project.json,**/*.csx,**/*.cake}',
+                    let watcher = this.vscode.workspace.createFileSystemWatcher('{**/*.sln,**/*.slnf,**/*.csproj,**/project.json,**/*.csx,**/*.cake}',
                         /*ignoreCreateEvents*/ false,
                         /*ignoreChangeEvents*/ true,
                         /*ignoreDeleteEvents*/ true);

tasks/testTasks.ts

@@ -45,6 +45,10 @@ gulp.task("test:integration:slnWithCsproj", async () => {
     return runIntegrationTest("slnWithCsproj");
 });
 
+gulp.task("test:integration:slnFilterWithCsproj", async () => {
+    return runIntegrationTest("slnFilterWithCsproj");
+});
+
 gulp.task("test:integration:BasicRazorApp2_1", async () => {
     return runIntegrationTest("BasicRazorApp2_1");
 });
@@ -53,6 +57,7 @@ gulp.task(
     "test:integration", gulp.series(
         "test:integration:singleCsproj",
         "test:integration:slnWithCsproj",
+        "test:integration:slnFilterWithCsproj",
         "test:integration:BasicRazorApp2_1"
     ));
 

test-plan.md

@@ -1,12 +1,12 @@
 # Validating C# Extension for VS Code
 
 #### Opening projects
-When you open a directory in VS Code, the C# extension should look for a .csproj or .sln file in that directory and use "OmniSharp" to load it. If a .cs file is present and no .csproj or .sln file are present, Omnisharp should start but the intellisense should only appear when a change is made to the file.
+When you open a directory in VS Code, the C# extension should look for a .csproj, .sln, or .slnf file in that directory and use "OmniSharp" to load it. If a .cs file is present and no .csproj, .sln, or .slnf file are present, Omnisharp should start but the intellisense should only appear when a change is made to the file.
 If you look in "Output > Omnisharp Log" a bunch of information should be printed about what copy of MSBuild was used and what projects were load
 
 Project types to test:
 * Standalone csproj
-* Directory containing .sln file that references csprojs--projects should be loaded
+* Directory containing .sln or .slnf file that references csprojs--projects should be loaded
 * .NET Core/.NET Standard csproj
 * (Windows) Desktop .NET projects
 * Unity projects

test/integrationTests/testAssets/slnFilterWithCsproj.ts

@@ -0,0 +1,15 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { ITestAssetWorkspace } from "./testAssets";
+
+let workspace: ITestAssetWorkspace = {
+    description: "sln filter with a csproj's",
+    projects: [{
+        relativeFilePath: "src/app/app.csproj"
+    }]
+};
+
+export default workspace;

test/integrationTests/testAssets/slnFilterWithCsproj/.gitignore

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

test/integrationTests/testAssets/slnFilterWithCsproj/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+    "omnisharp.defaultLaunchSolution": "SolutionFilter.slnf",
+    "omnisharp.path": "latest",
+    "omnisharp.enableRoslynAnalyzers": true
+}