PSScriptAnalyzer

1.6.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.6.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

Release v1.6.0 (June 7, 2016)

Engine:
- Add SuggestedCorrections property to DiagnosticRecord
   - This property emits text that can rectify the violation which triggered the rule.
   - The primary purpose of this feature is to enable quick-fix scenarios in editors (e.g. vscode)
- Add "Name" as a positional parameter in Get-ScriptAnalyzerRule
- Add a SaveDscDependency switch to allow Invoke-ScriptAnalyzer to download a DSC Resource module from PSGallery in the event of a ModuleNotFoundDuringParse parse error. This feature is available only for PSv5 and above.
- Add remove verb to UseShouldProcessForStateChangingFunctions rule
- Add a ScriptPath property to Diagnostic Record that returns the full path of the script
- Add PSv4 (Windows Server 2012 R2) and PSv3 (Windows Server 2012) to build and test matrix on AppVeyor
- Fix the parsing of Settings parameter value when a hashtable is given
- Fix writing error record while running rule suppression
- Fix rule suppression in DSC Configuration definitions
- Fix build and tests on PSv4 and v3

Rules:
- Add suggested corrections feature to the following rules.
   - PSAvoidUsingCmdletAliases
   - PSAvoidUsingPlainTextForPassword
   - PSMisleadingBacktick
   - PSUseToExportFieldsInManifest
   - PSMissingModuleManifestField
- Fix extent of
   - PSUseSingularNoun
   - PSUseApprovedVerb
   - PSAvoidUsernameAndPasswordParams
- Fix a bug in PSMissingModuleManifestField rule caused by .psd1 files that do not contain Hashtable
- Fix documentation of PSAvoidUsingPlainTextForPassword

Version History

Version Downloads Last updated
1.18.1 37,051 6/13/2019
1.18.0 79,863 3/21/2019
1.17.1 184,433 6/5/2018
1.16.1 91,744 9/5/2017
1.16.0 5,336 8/16/2017
1.15.0 13,326 6/21/2017
1.14.1 2,362 6/12/2017
1.14.0 608 6/9/2017
1.13.0 5,468 5/18/2017
1.12.0 1,973 5/9/2017
1.11.1 6,803 4/4/2017
1.11.0 6,585 3/1/2017
1.10.0 5,910 1/19/2017
1.9.0 4,773 12/6/2016
1.8.1 6,466 10/14/2016
1.8.0 971 10/8/2016
1.7.0 4,908 8/18/2016
1.6.0 (current version) 28,450 6/7/2016
1.5.0 4,618 3/30/2016
1.4.0 2,759 2/17/2016
1.3.0 917 1/19/2016
1.2.0 1,494 12/16/2015
1.1.1 576 11/4/2015
1.1.0 561 9/1/2015
1.0.2 291 6/24/2015
1.0.1 156 5/8/2015
1.0 119 4/24/2015
Show less