PSScriptAnalyzer

1.13.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.13.0

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deploy 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
- `PSUseSupportsShouldProcess` rule to discourage manual `whatif` and `confirm` parameter declarations.
- Suggested corrections to `PSProvideCommentHelp` rule. The rule can now be configured to:
   - trigger on non-exported functions. But by default, the rule triggers only on exported functions that do have comment help.
   - place the suggested corrections either before a function definition, or at the beginning or end of a function's body.
   - choose between block comment or line comment style of suggested comment help correction.

### Fixed
- `PSAlignAssignmentStatement` to align assignment statements in DSC configurations that have *Undefined DSC Resource* parse errors.

Version History

Version Downloads Last updated
1.19.1 302,389 7/28/2020
1.19.0 156,186 5/4/2020
1.18.3 396,099 9/16/2019
1.18.2 21,513 9/3/2019
1.18.1 103,623 6/13/2019
1.18.0 118,424 3/21/2019
1.17.1 208,869 6/5/2018
1.16.1 102,678 9/5/2017
1.16.0 5,377 8/16/2017
1.15.0 16,658 6/21/2017
1.14.1 2,375 6/12/2017
1.14.0 621 6/9/2017
1.13.0 (current version) 5,557 5/18/2017
1.12.0 1,993 5/9/2017
1.11.1 6,819 4/4/2017
1.11.0 7,094 3/1/2017
1.10.0 5,926 1/19/2017
1.9.0 4,927 12/6/2016
1.8.1 6,828 10/14/2016
1.8.0 990 10/8/2016
1.7.0 4,932 8/18/2016
1.6.0 28,508 6/7/2016
1.5.0 4,705 3/30/2016
1.4.0 2,801 2/17/2016
1.3.0 927 1/19/2016
1.2.0 12,213 12/16/2015
1.1.1 592 11/4/2015
1.1.0 581 9/1/2015
1.0.2 305 6/24/2015
1.0.1 174 5/8/2015
1.0 149 4/24/2015
Show less