PSScriptAnalyzer

1.11.0

PSScriptAnalyzer provides script analysis and checks for potential code defects in the scripts by applying a group of built-in or customized rules on the scripts being analyzed.

Minimum PowerShell version

3.0

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name PSScriptAnalyzer -RequiredVersion 1.11.0

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deloy all the dependencies to Azure Automation. Learn More

Manually download the .nupkg file to your system's default download location. Note that the file won't be unpacked, and won't include any dependencies. Learn More

Author(s)

Microsoft Corporation

Copyright

(c) Microsoft Corporation 2016. All rights reserved.

Owners

Tags

lint bestpractice

Cmdlets

Get-ScriptAnalyzerRule Invoke-ScriptAnalyzer

Dependencies

This module has no dependencies.

Release Notes

### Added
- Built-in settings presets to specify settings from command line (#717). Currently, PSSA ships with `PSGallery`, `CodeFormatting`, `DSC`, and other settings presets. All of them can be found in the `Settings/` directory in the module. To use them just pass them as an argument to the `Settings` parameter. For example, if you want to run rules that *powershellgallery* runs, then use the following command.
```powershell
PS> Invoke-ScriptAnalyzer -Path /path/to/your/module -Settings PSGallery
```
- Argument completion for built-in settings presets (#717).
- Argument completion for `IncludeRule` and `ExcludeRule` parameters (#717).
- Option to `PSCloseBrace` rule to add new line after the brace (#713).
- Option to `PSCloseBrace` rule to ignore expressions that have open and close braces on the same line (#706).
- New rule, PSUseConsistentWhitespace, to check for whitespace style around operators and separators (#702).

### Fixed
- Indentation when pipes precede new lines in a multi-line command expression in `PSUseConsistentIdentation` rule (#705).
- Handling of SubExpressionAsts (`$(...)`) in `PSUseConsistentIdentation` rule (#700).
- Performance issues caused by `get-command` cmdlet (#695).

### Changed
- Settings implementation to decouple it from engine (#717).

Version History

Version Downloads Last updated
1.17.1 52,842 6/5/2018
1.16.1 85,350 9/5/2017
1.16.0 4,932 8/16/2017
1.15.0 12,360 6/21/2017
1.14.1 2,355 6/12/2017
1.14.0 604 6/9/2017
1.13.0 5,413 5/18/2017
1.12.0 1,965 5/9/2017
1.11.1 6,788 4/4/2017
1.11.0 (current version) 6,478 3/1/2017
1.10.0 5,903 1/19/2017
1.9.0 4,662 12/6/2016
1.8.1 6,343 10/14/2016
1.8.0 965 10/8/2016
1.7.0 4,902 8/18/2016
1.6.0 28,333 6/7/2016
1.5.0 4,588 3/30/2016
1.4.0 2,693 2/17/2016
1.3.0 913 1/19/2016
1.2.0 1,482 12/16/2015
1.1.1 570 11/4/2015
1.1.0 545 9/1/2015
1.0.2 287 6/24/2015
1.0.1 152 5/8/2015
1.0 111 4/24/2015
Show less