Fix project.json search in DotNetProjectSystem #673
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This change fixes several issues with locating project.json projects: 1. The top-level folders defined in global.json were not searched. So, if a user tried to add `"projects": ["MyProject1"]` where `MyProject1` contained a project.json file, the project wouldn't be found. Instead, only child folders of the top-level folders would be search. So, `src/MyProject1` would work. Now, we'll search the top-level folders and their immediate children, which should match how `dotnet restore` behaves a bit more closely. A test has been added for this scenario. 2. We had infrastructure for falling back to a recursive directory search when a project.json or global.json doesn't exist in the current directory. However, we weren't using it! There was an issue with the recursive search (it wouldn't search a directory's sub-directories if the directory contained a project.json file), but that is now fixed. 3. The test for recursively searching wasn't correct. This is now fixed.
filipw
reviewed
Nov 22, 2016
| @@ -156,7 +112,7 @@ private static IEnumerable<ProjectDescription> GetProjectReferences(ProjectConte | |||
| continue; | |||
| } | |||
|
|
|||
| // if this is an assembly reference then don't threat it as project reference | |||
| // if this is an assembly reference then don't treat it as project reference | |||
DustinCampbell
commented
Nov 22, 2016
| } | ||
|
|
||
| public static IEnumerable<string> Search(string solutionRoot, int maxDepth) | ||
| public static IEnumerable<string> Search(string directory, int maxDepth) |
There was a problem hiding this comment.
Note that this function was inconsistent before my changes. Sometimes it would return a directory path to a project.json files, and sometimes it would return multiple file paths to project.json files. Now, it just returns file paths to project.json files.
david-driscoll
approved these changes
Nov 22, 2016
| var projectPaths = new SortedSet<string>(StringComparer.OrdinalIgnoreCase); | ||
| var searchDirectories = new Queue<string>(); | ||
|
|
||
| // Look in global.json 'projects' search paths and their immediate children |
There was a problem hiding this comment.
For my sanity (because project.json is starting to fade with csproj out soon 😜).
global.json never supported wild cards, but instead just looked to see if it a any project.json in the folder or it's children. ie the common case was projects: ["src", "test"].
There was a problem hiding this comment.
Were you looking for a change here?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change fixes several issues with locating project.json projects:
The top-level folders defined in global.json were not searched. So, if a user tried to add
"projects": ["MyProject1"]whereMyProject1contained a project.json file, the project wouldn't be found. Instead, only child folders of the top-level folders would be search. So,src/MyProject1would work. Now, we'll search the top-level folders and their immediate children, which should match howdotnet restorebehaves a bit more closely. A test has been added for this scenario.We had infrastructure for falling back to a recursive directory search when a project.json or global.json doesn't exist in the current directory. However, we weren't using it! There was an issue with the recursive search (it wouldn't search a directory's sub-directories if the directory contained a project.json file), but that is now fixed.
The test for recursively searching directories wasn't correct. This is now fixed.
This fixes dotnet/vscode-csharp#962 and dotnet/vscode-csharp#904