Add ImplementingType to RuleInfo object#1250
Merged
JamesWTruher merged 2 commits intoPowerShell:developmentfrom Jun 5, 2019
Merged
Add ImplementingType to RuleInfo object#1250JamesWTruher merged 2 commits intoPowerShell:developmentfrom
JamesWTruher merged 2 commits intoPowerShell:developmentfrom
Conversation
This will enable easier creation of settings file validation and settings file template creation.
bergmeister
approved these changes
Jun 5, 2019
Collaborator
bergmeister
left a comment
There was a problem hiding this comment.
Apart from a small comment about a property, looks good to me, thanks.
| /// <summary> | ||
| /// ImplementingType : The type which implements the rule. | ||
| /// </summary> | ||
| [SuppressMessage("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")] |
Collaborator
There was a problem hiding this comment.
I think the CA rule is right to call this out. C# has auto-properties now that can simplify this property to public Type { get; } whereby the private setter is included by default.
Contributor
Author
There was a problem hiding this comment.
yah - I didn't want to change them all, so I just followed the previous example for consistency. I'm certainly happy to change all of them.
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
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.
PR Summary
This will enable easier creation of settings file validation and settings file template creation.
Navigating to the actual implementation of the rule is quite difficult, by providing the implementing type of the rule, this becomes much easier. This is similar to how
CmdletInfoworks in PowerShell where there is an ImplementingType property on the CmdletInfo object.This will enable a couple of things; first, we'll be able to create validation of settings file without translating the rule name to the type that implements (so you can very easily retrieve the configurable properties). Second, it will also be possible to write tools to create templates for settings.
PR Checklist
.cs,.ps1and.psm1files have the correct copyright headerWIP:to the beginning of the title and remove the prefix when the PR is ready.