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.

Inspect

Install

Deploy

See Documentation for more details.

Release Notes

Released v1.2.0 (Dec.17, 2015)

Features:
- Support for consuming PowerShell content as streams (-ScriptDefinition)
- ScriptAnalyzer accepts configuration (settings) in the form of a hashtable (-Settings), added sample Settings
- Ability to run default ruleset along with custom ones in the same invocation (-IncludeDefaultRules)
- Recurse Custom Rule Paths (-RecurseCustomRulePath)
- Consistent Engine error handling when working with Settings, Default and Custom Rules

Rules:
- Rule to detect the presence of default value for Mandatory parameters (AvoidDefaultValueForMandatoryParameter)

Fixes:
Engine:
- Engine update to prevent script based injection attacks
- CustomizedRulePath is now called CustomRulePath – Fixes to handle folder paths
- Fixes for RecurseCustomRulePath functionality
- Fix to binplace cmdlet help file as part of build process
- ScriptAnalyzer Profile is now called Settings
- Fix to emit filename in the diagnosticrecord when using Script based custom rules
- Fix to prevent Engine from calling Update-Help for script based custom rules
- Added additional pester tests to take care of test holes in Custom Rule feature
- Post-build error handling improvements, fixed typos in the project

Rules:
- Fixed bug in Positional parameter rule to trigger only when used with > 3 positional  - parameters
- Updated keywords that trigger PSAvoidUsingPlainTextForPassword rule
- Updated ProvideDefaultParameterValue rule to AvoidDefaultValueForMandatoryParameter rule
- Deprecate Internal Url rule based on community feedback, identified additional rules to handle hardcoded paths etc
- Added localhost exceptions for HardCodedComputerName Rule
- Update to Credential based rules to validate the presence of CredentialAttribute and PSCredential type

Documentation:
- Rule & Cmdlet documentation updates – Cmdlet help file addition

Owners

• PowerShellTeam
• kborle

Copyright

(c) Microsoft Corporation 2015. All rights reserved.

FileList

Show

Cmdlets

Dependencies

This module has no dependencies.

Version History

Version	Downloads	Last updated
PSScriptAnalyzer 1.17.1 (latest stable)	7131	Tuesday, June 05 2018
PSScriptAnalyzer 1.16.1	82129	Tuesday, September 05 2017
PSScriptAnalyzer 1.16.0	4885	Wednesday, August 16 2017
PSScriptAnalyzer 1.15.0	12350	Wednesday, June 21 2017
PSScriptAnalyzer 1.14.1	2353	Monday, June 12 2017
PSScriptAnalyzer 1.14.0	602	Friday, June 09 2017
PSScriptAnalyzer 1.13.0	5383	Thursday, May 18 2017
PSScriptAnalyzer 1.12.0	1963	Tuesday, May 09 2017
PSScriptAnalyzer 1.11.1	6775	Tuesday, April 04 2017
PSScriptAnalyzer 1.11.0	6460	Wednesday, March 01 2017
PSScriptAnalyzer 1.10.0	5901	Thursday, January 19 2017
PSScriptAnalyzer 1.9.0	4628	Tuesday, December 06 2016
PSScriptAnalyzer 1.8.1	6322	Friday, October 14 2016
PSScriptAnalyzer 1.8.0	963	Saturday, October 08 2016
PSScriptAnalyzer 1.7.0	4900	Thursday, August 18 2016
PSScriptAnalyzer 1.6.0	28288	Tuesday, June 07 2016
PSScriptAnalyzer 1.5.0	4582	Wednesday, March 30 2016
PSScriptAnalyzer 1.4.0	2677	Wednesday, February 17 2016
PSScriptAnalyzer 1.3.0	911	Tuesday, January 19 2016
PSScriptAnalyzer 1.2.0 (this version)	1460	Wednesday, December 16 2015
PSScriptAnalyzer 1.1.1	568	Wednesday, November 04 2015
PSScriptAnalyzer 1.1.0	540	Tuesday, September 01 2015
PSScriptAnalyzer 1.0.2	285	Wednesday, June 24 2015
PowerShell ScriptAnalyzer 1.0.1	150	Friday, May 08 2015
PowerShell ScriptAnalyzer 1.0	110	Friday, April 24 2015