Is there a PowerShell code formatter / pretty printer? [closed]

Question

I'm looking for a source code beautifyer for PowerShell programs. Ideally, it would be CLI based, but any solution is acceptable. I would like to avoid configuring a generic pretty printer tool; I'd like a solution that works for PowerShell out of the box. Is there such a thing?

Alphabetic

Try Visual Studio Code with Powershell Extension: marketplace.visualstudio.com/… – Fecundate

@Fecundate are you saying that extension has code formatting? It doesn't mention that anywhere? – Galina

Answer 1

UPDATE: it's now on GitHub: https://github.com/DTW-DanWard/PowerShell-Beautifier

I wrote a PowerShell pretty printer / code cleaner in PowerShell. It cleans white space, indents code groups, replaces aliases with commands, fixes casing on commands, parameters, types, etc. You can use it to reformat a file in place or read a source file and output the result in a different file.

More info: http://danspowershellstuff.blogspot.com/2012/03/powershell-pretty-printer-code-cleaner.html

Download page: http://www.dtwconsulting.com/PS/Module_PrettyPrinterV1.htm

Let me know what you'd like to see changed/configurable/etc.

Alcuin

YES! You awesome guy you! – Derickderide

Have you considered porting your code to GitHub so others can contribute? – Goldston

Yep - I've been working on cleaning it up and completing test files and documentation. Should be up in the next few days. – Alcuin

It's now on GitHub: https://github.com/DTW-DanWard/PowerShell-Beautifier – Alcuin

I cannot get this to work for the life of me. Can you provide better instructions. I downloaded the source now what? – Agitprop

Backup/commit your PowerShell file first or practice on a test copy! Assume your file is: c:\Temp\TestFile.ps1 Open PowerShell Window Import-Module C:\Temp\PowerShell-Beautifier\src\DTW.PS.Beautifier.psd1 (Takes a few seconds the first time.) Edit-DTWBeautifyScript c:\Temp\TestFile.ps1 This cleans file in place, overwriting orig copy (thus the need for the backup or commit first). Or you can: Edit-DTWBeautifyScript c:\Temp\TestFile.ps1 c:\Temp\CleanFile.ps1 Outputs the results to a new file, leaving the first untouched. github.com/DTW-DanWard/PowerShell-Beautifier#usage – Alcuin

Answer 2

I don't know of any. However, PowerShell V2 exposes a PowerShell tokenizer you could build on: System.Management.Automation.PsParser

It might be interesting to do some "lint"-like checks, too.

For example, I think scripts should avoid using aliases that aren't marked ReadOnly, as users may have changed them. See Where are the default aliases defined in powershell? for some discussion.

Geologize

Answer 3

Take a look at ScriptCop.
Props to Mike Shepard - I found this from his answer here.

Identity