PSScriptAnalyzer 模块

PSScriptAnalyzer 是 PowerShell 模块和脚本的静态代码检查器。 PSScriptAnalyzer 通过运行一组规则来检查 PowerShell 代码的质量。 这些规则基于 PowerShell 团队和社区确定的 PowerShell 最佳做法。 它生成 DiagnosticResults (错误和警告) 通知用户潜在的代码缺陷,并建议可能的改进解决方案。

PSScriptAnalyzer 附带一组内置规则,这些规则检查 PowerShell 代码的各个方面,例如:

  • 存在未初始化的变量
  • PSCredential 类型的使用
  • 使用 Invoke-Expression
  • 以及更多

可以选择要为模块和脚本包括或排除的规则。 PSScriptAnalyzer 还可以修复代码的格式设置。 这有助于生成符合标准样式、更易于阅读且更易于维护的代码。

安装 PSScriptAnalyzer

支持的 PowerShell 版本和平台

  • Windows PowerShell 3.0 或更高版本
  • Windows/Linux/macOS 上的 PowerShell 7.0.11 或更高版本

使用 PowerShellGet 2.x 安装:

Install-Module -Name PSScriptAnalyzer -Force

使用 PSResourceGet 1.x 安装:

Install-PSResource -Name PSScriptAnalyzer -Reinstall

仅当安装了较旧版本的 PSScriptAnalyzer 时, 才需要 Force重新安装 参数。 即使未安装以前的版本,这些参数也起作用。