PSScriptAnalyzer

1.2.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.

Installation Options

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

Install-Module -Name PSScriptAnalyzer -RequiredVersion 1.2.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 2015. All rights reserved.

Owners

Cmdlets

Get-ScriptAnalyzerRule Invoke-ScriptAnalyzer

Dependencies

This module has no dependencies.

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

Version History

Version Downloads Last updated
1.17.1 106,008 6/5/2018
1.16.1 86,948 9/5/2017
1.16.0 4,982 8/16/2017
1.15.0 12,396 6/21/2017
1.14.1 2,356 6/12/2017
1.14.0 604 6/9/2017
1.13.0 5,425 5/18/2017
1.12.0 1,965 5/9/2017
1.11.1 6,796 4/4/2017
1.11.0 6,501 3/1/2017
1.10.0 5,903 1/19/2017
1.9.0 4,688 12/6/2016
1.8.1 6,381 10/14/2016
1.8.0 965 10/8/2016
1.7.0 4,902 8/18/2016
1.6.0 28,360 6/7/2016
1.5.0 4,600 3/30/2016
1.4.0 2,707 2/17/2016
1.3.0 913 1/19/2016
1.2.0 (current version) 1,485 12/16/2015
1.1.1 571 11/4/2015
1.1.0 548 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