Rule Idea: .NET Constructor Auto Document/Align

[JustinGrote]

Summary of the new feature

When instantiating dotnet objects with [Class]::new(), the syntax is generally obtuse for anyone coming along to read it. Reflection could be used to expand out the definition to the proper constructor from the OverloadDefinitions using the AST and comment the properties, since hashtable constructor syntax only works if the object has no constructors.

Proposed technical implementation details (optional)

Before:

[datetime]::new(2000, 6, 20)

After formatting:

[DateTime]::new(
    2000,   #int year
    6,      #int month
    20,     #int day
)

Major issue here would be variables, since Powershell is not statically typed it won't know what type the variable should be until runtime. This is only the problem in the case of overloaded constructors with the same number of arguments, maybe could still work if someone strongly typed the variable ahead of time that the AST could parse, e,g, [int]$Month?

What is the latest version of PSScriptAnalyzer at the point of writing
1.19.1.0

[SydneyhSmith]

Thanks @JustinGrote we agree that this is a valid feature request and could be useful, however it would be a large undertaking, and not possible in all cases--- not sure we when we will have capacity to give this a deeper look but thanks for the thought out proposal. If you want to pick up this work we can discuss in more detail how to handle cases where the comments may not be possible and how we can ensure we dont accidently invent too much complexity.