Consistent Script formatting

[dpaulson45]

We also need to decide on a consistent set of styling rules and shift-alt-F these files in VSCode. For example, in some places we have Javascript-style braces (my own preference), and in some places we have C# style braces. In some places we have <# #> multiline comments, and in other places we have # multiline comments. But we can address styling consistency in a separate PR.

Originally posted by @bill-long in #8 (comment)

+++++++++++++++++++++++++++++++++

Not sure if we can get the comments in there, but we can align to something within a build pipeline for this. This makes it easier for other people to contribute to the project as well without having them need to setup VSCode and pressing shift-alt-F.

One option that I have played around with is this one:

https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/markdown/Invoke-Formatter.md

We should be able to easily add this to a build pipeline.

Import-Module PSScriptAnalyzer
$content = Get-Content .\Setup\SetupAssist.ps1
$stringContent = [string]::Empty
foreach($line in $content)
{
    $stringContent += "{0}`r`n" -f $line
}

$test = Invoke-Formatter $stringContent -Setting .\settings\codeformatting.psd1
if ($test -ne $content)
{
    throw "failed to meet code formatting requirements"
}

another option appears to be this one:

https://sumtips.com/software/powershell-beautifier-free-tool-to-pretty-print-ps1-script-files/#:~:text=%20How%20to%20Use%20PowerShell%20Beautifier%20%201,Save%20Formatted%20Code%20as%20New%20File.%20More%20

I haven't looked much into it.

[dpaulson45]

I personally like Allman style, but it looks like more people like OTBS.

PoshCode/PowerShellPracticeAndStyle#81

[dpaulson45]

Completed in PR #12