PowerShell 格式化器：代码整洁新境界

在编写Windows PowerShell或PowerShell Core（跨所有操作系统）的脚本时，代码的整洁和规范性至关重要。Tab还是空格？空格数量多少合适？PowerShell Beautifier是一个专为此而生的工具，它不仅关注你的缩进风格，更关注整个代码的整洁与规范。

简介

PowerShell Beautifier 是一个以PowerShell编写的命令行实用程序，用于清理和重新格式化PowerShell脚本文件。它的主要任务是：

• 使用tabs或spaces进行正确缩进；
• 清理并重组一行中的所有空白字符；
• 将别名替换为命令名称；
• 纠正命令名、参数名和类型名的大小写；

看看下面的例子你就知道效果有多显著了：通过VS Code的前后对比，以及两个不同的差异查看器展示了别名更换、大小写修正等改变。

此工具会执行以下操作：

• 正确缩进{}，[]，()和$()内的代码
• 清理并重排行内所有空白
• 别名替换为全称：dir → Get-ChildItem
• 命令名大小写修正：get-childitem → Get-ChildItem
• 参数名大小写修正：-path → -Path
• 类型名大小写修正
  • 缩写类型加速器：[STRING] → [string]
  • 其他类型的内存修正：[system.exception] → [System.Exception]
• 每个文件以换行符结束

测试与支持

每个版本的PowerShell Beautifier都会在以下环境中进行全面测试：

• Windows PowerShell (v5)（原生）
• PowerShell Core - Windows （原生）
• Ubuntu 16.04 和 CentOS 7（官方PowerShell Core Docker容器）

也偶尔会在OSX，Ubuntu 16.04，Windows Server 2016 Core 和 Nano上进行测试。

内容导航

• 安装
• 使用方法
  • 用2个空格对单个文件进行原地更新
  • 用tab对单个文件进行原地更新
  • 输出2个空格缩进的新文件
  • 遍历目录结构中的多个文件
  • 通过标准输出获取清理后的内容而不更新文件
  • 始终使用LF作为换行符
• 了解更多
• 贡献指南
• 致谢
• 许可协议

安装与使用

1. 下载PowerShell Beautifier。可以克隆，压缩或从PowerShell Gallery中获取：

   Install-Module -Name PowerShell-Beautifier
   

2. 导入模块。首次导入可能需要几秒钟，但之后速度很快。

   Import-Module .\PowerShell-Beautifier.psd1
   

3. 验证是否已加载：

   Get-Help Edit-DTWBeautifyScript
   
   NAME
       Edit-DTWBeautifyScript
   
   SYNOPSIS
       清理PowerShell脚本：用空格或制表符进行缩进，清理和重新排列行内所有空白，
       替换别名，修正命令名大小写，修正参数名大小写，修正[type]大小写等。
   
   ...
   
   

使用提示

在使用该工具之前，请备份你的文件！通过提交，备份或其他方式。**不指定-DestinationPath参数将直接修改源文件！**虽然我已经在许多脚本上运行了这个工具，但我不能保证在某些异常的脚本上不会出现问题。安全起见，先备份！

更多使用方法请参阅文档。例如：

单个文件，2个空格缩进，原地更新

Edit-DTWBeautifyScript C:\temp\MyFile.ps1

单个文件，tab缩进，原地更新

Edit-DTWBeautifyScript C:\temp\MyFile.ps1 -IndentType Tabs

输出新的2个空格缩进的文件

Edit-DTWBeautifyScript -SourcePath C:\temp\MyFile.ps1 -DestinationPath c:\temp\MyFile_AFTER.ps1

遍历目录结构中的多个文件

Get-ChildItem -Path c:\temp -Include *.ps1,*.psm1 -Recurse | Edit-DTWBeautifyScript

通过标准输出获取内容，而不是更新文件

Edit-DTWBeautifyScript C:\temp\MyFile.ps1 -StandardOutput

无论什么操作系统，始终使用LF作为换行符

Edit-DTWBeautifyScript C:\temp\MyFile.ps1 -NewLine LF

更多信息

• 常见问题解答
• 工作原理
• 如何添加和测试用例
• 在外部编辑器如Atom中集成
• 项目路线图
• 变更日志

贡献指南

我们欢迎各种形式的参与：

• 进行测试，发现功能优势及改进点；
• 帮助添加外部编辑器的支持；
• 甚至贡献代码！

致谢

Dan Ward在2011年创建了PowerShell Beautifier，最近才将其放入GitHub。

许可协议

PowerShell Beautifier遵循MIT许可证。