Add code formatting option for lining up assignment operators in DSC configurations

[daviwil]

When a user writes a DSC configuration, they might line up their assignment statements like this:

configuration MyConfiguration {
    xDscWebService PSDSCPullServer {
        Ensure                = “Present”
        EndpointName          = “PSDSCPullServer”
        Port                  = 8080
        PhysicalPath          = “$env:SystemDrive\inetpub\wwwroot\PSDSCPullServer”
        CertificateThumbPrint = “AllowUnencryptedTraffic”
    }
}

We should do this formatting for them so that when they add new properties they can reformat the configuration and have all the properties be lined up at the equal signs again.

/cc @jpsnover @smurawski

[smurawski]

Folks also tend to do this with hashtables (especially when constructing one to splat into another command).

[kapilmb]

I think this rule would be a great addition to our existing set of rules. But do we want to limit ourselves just to Configurations or Hashtables? Should it be general enough that whenever there are consecutive assignment statements, it should take effect? Or maybe we can provide options wherein the user can select if they want to line up only property value pairs or consecutive assignment statements.

[dotps1]

I would prefer options, as I do not line the equal signs up, and would prefer not to be forced to.

[daviwil]

@kapilmb let's go with just configurations and hashtables for now and then expand to others if we get feedback on that

[daviwil]

@dotps1 we'll definitely have an option to turn it off!

[fodonnel]

This rule is not very version control friendly.

If I remove CertificateThumbPrint from the above example then all the other lines in the resource move back and look like the have been edited if I do a compare.

If i also had actually edited another line - like changing the port it would not be clear. There are ignore whitespace settings that I use for the compare, the they are not the default behaviour.

[daviwil]

That's a fair point, though I don't see any way around this other than just turning off the rule if it's problematic for you. Can you think of a better option?