Improved nullability annotations in MVVM Toolkit#4135
Merged
michael-hawker merged 3 commits intoCommunityToolkit:mainfrom Aug 2, 2021
Merged
Conversation
Sergio0694
added
improvements ✨
.NET
|
Thanks Sergio0694 for opening a Pull Request! The reviewers will test the PR and highlight if there is any conflict or changes required. If the PR is approved we will proceed to merge the pull request 🙌 |
ghost
requested review from
Sergio0694
force-pushed
the
improvement/mvvmtoolkit-annotations
branch
from
30b0383 to
a6a15dc
Compare
XAML-Knight
approved these changes
Jul 30, 2021
michael-hawker
approved these changes
Aug 2, 2021
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Contributes to #3873
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Some helper methods lack some nullability annotations. Specifically:
SetPropertymethods directly target a backing field don't indicate that if the supplied input value is not null, then the target field will also always be not null once the method returns (as the two aren't equal).SetPropertyAndNotifyOnCompletionmethods don't indicate that the targetTaskNotifierinstance will always be not null once the method returns (as the field is always immediately initialized as soon as the method is invoked).What is the new behavior?
[NotNullIfNotNull]to mark target fields forSetProperty[NotNull]to mark target task notifiers inSetPropertyAndNotifyOnCompletion.Also had to update the source generator project to ensure the attributes are automatically generated in consuming projects in case they're not available in the compilation, to ensure we don't generate code that will then cause the build to fail. The generator will just bail out early and not do anything if consumers are on .NET Standard 2.1 or above.
PR Checklist
Please check if your PR fulfills the following requirements:
Pull Request has been submitted to the documentation repository instructions. Link:Sample in sample app has been added / updated (for bug fixes / features)Icon has been created (if new sample) following the Thumbnail Style Guide and templatesNew major technical changes in the toolkit have or will be added to the Wiki e.g. build changes, source generators, testing infrastructure, sample creation changes, etc...