Enable code formatter to enforce consistent whitespace style #489
Conversation
src/features/DocumentFormatter.ts
Outdated
| @@ -139,6 +139,7 @@ class PSDocumentFormattingEditProvider implements DocumentFormattingEditProvider | |||
| private readonly ruleOrder: string[] = [ | |||
| "PSPlaceCloseBrace", | |||
| "PSPlaceOpenBrace", | |||
| "PSUseWhitespace", | |||
There was a problem hiding this comment.
Should this be named PSUseConsistentWhitespace?
There was a problem hiding this comment.
I was in a bit of a limbo on whether to have "consistent" in its name. But looks like "PSUseConsistentWhitespace" sounds more consistent with the "PSUseConsistentIndentation" rule. On the other hand all the rules enforce some or the other kind of consistency and so having the "consistent" word seemed verbose (And I was even thinking of changing "PSUseConsistentIndentation" to "PSUseIndentation", but that would be a breaking change for PSSA). At this point, I personally don't have any preference but if you think "PSUseConsistentWhitespace" sounds better, I can change it to that.
There was a problem hiding this comment.
I think consistency would be nice between the two names. "PSUseIndentation/Whitespace" doesn't sound specific enough to me; the "Consistent" designation helps with that. I've tried thinking of other names and I can't come up with anything better at the moment.
There was a problem hiding this comment.
Fixed!
Also made corresponding changes to PowerShell/PSScriptAnalyzer#702
|
@daviwil Thanks! |
Resolves #446.