Code analyzer to check the type passed to ProvideOptionDialogPageAttribute and ProvideProfileAttribute #284
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.
Related to #279.
Using the wrong type in
ProvideOptionPageAttribute
seemed like a good candidate for a code analyzer to catch the problem early and to suggest a fix (where possible).CVST003 will detect the wrong type being provided to
ProvideLanguageEditorOptionPageAttribute
,ProvideOptionPageAttribute
andProvideToolboxPageAttribute
(they all expect aDialogPage
)CVST004 will detect the wrong type being provided to
ProvideProfileAttribute
(it expects anIProfileManager
, whichDialogPage
implements).Both diagnostics have a code fix that will suggest changing the type to a type that is nested within the type nested type that inherits/implements the correct type. For example, give this:
and providing an options page like this:
The code fix will suggest:
typeof(OptionsProvider)
totypeof(OptionsProvider.GeneralOptions)
typeof(OptionsProvider)
totypeof(OptionsProvider.OtherOptions)
Demo: