Rationalize ProjectSnapshotManager methods #11294
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 method just delegates to TryGetDocument, so it can be converted to an extension method.
Most callers of IProjectSnapshot.GetDocument() assume the result is non-null, so IProjectSnapshot.GetRequiredDocument() will verify the result.
This allows checking for the presence of a project without retrieving a snapshot.
This name better matches its Roslyn cousin: GetDocumentIdsWithFilePath.
davidwengier
approved these changes
Dec 11, 2024
ryzngard
approved these changes
Dec 11, 2024
DustinCampbell
deleted the
rationalize-projectsnapshotmanager-methods
branch
This was referenced Dec 13, 2024
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 pull request is an attempt to rationalize and normalize the "Get" methods on
IProjectSnapshotMangerandIProjectSnapshot. The goal here is to try and match common naming conventions (e.g. GetLoadedProject becomes GetRequiredProejct) and match Roslyn where appropriate. In addition, some methods have been converted to or introduced as extension methods. This allows the interfaces to stay light a bit lighter and exclude members that have the same implementation across the code base. This is especially useful forIProjectSnapshot, which is implemented asProjectSnapshotandRemoteProjectSnapshot.Reviewing commit-by-commit might be helpful.