{"id":1201,"date":"2015-04-29T14:34:00","date_gmt":"2015-04-29T22:34:00","guid":{"rendered":"https:\/\/blogs.msdn.microsoft.com\/powershell\/2015\/04\/29\/scriptanalyzer-in-github-and-availability-on-powershell-gallery\/"},"modified":"2022-05-23T09:46:16","modified_gmt":"2022-05-23T17:46:16","slug":"scriptanalyzer-in-github-and-availability-on-powershell-gallery","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/powershell\/scriptanalyzer-in-github-and-availability-on-powershell-gallery\/","title":{"rendered":"ScriptAnalyzer in GitHub and availability on PowerShell Gallery"},"content":{"rendered":"

With the release of Windows Management Framework 5.0 April Preview<\/a>, we are excited to announce that PowerShell ScriptAnalyzer development has moved to GitHub for greater collaboration & community involvement.<\/span><\/p>\n

https:\/\/github.com\/PowerShell\/PSScriptAnalyzer<\/a><\/span> <\/p>\n

Also, we have published v1.0 of ScriptAnalyzer to PSGallery.<\/span><\/p>\n

https:\/\/www.powershellgallery.com\/packages\/PSScriptAnalyzer\/<\/a><\/span> <\/p>\n

Here are the significant changes in this release:<\/span>
 <\/p>\n

Features:<\/strong><\/span><\/pre>\n
    \n
  • “Recursive” switch to analyze a folderpath in Invoke-ScriptAnalyzer<\/span><\/li>\n
  • Three levels of Severity – Error\/Warning\/Informational<\/span><\/li>\n
  • Robust Engine that does emits non-terminating errors (Ex: for failed ast parse) and continues rule application when running on multiple scripts<\/span><\/li>\n
  • Add wild card supports for rules in Invoke-ScriptAnalyzer and Get-ScriptAnalyzerRule. Eg. Invoke-ScriptAnalyzer -IncludeRule PSAvoid* will apply all rules starting with PSAvoid* in built in rule assemblies.<\/span><\/li>\n
  • Add -Severity to Get-ScriptAnalyzerRules. Get-ScriptAnalyzer -Severity will filter rules based on the severity given.<\/span><\/li>\n
  • Suppression functionality. Users are now able to specify suppression on certain parts of the scripts by specifying “SupressMessageAttribute”. Also comes with this feature is the ability for users to display a list of suppressed messages.<\/span> <\/li>\n<\/ul>\n

    Rules:<\/strong><\/span><\/pre>\n
      \n
    • DSC Rules for resources – Parameter validation, Usage of standard DSC functions, return type validation, support for DSC classes<\/span><\/li>\n
    • Detecting the usage of positional parameters as opposed to using named parameters<\/span><\/li>\n
    • Detect DSC configuration\/resource files and disable default rule checkings on DSC configuration and resource files.<\/span><\/li>\n
    • UseShouldProcessForStateChangingFunctions – If an advanced function has Verbs like New\/Start\/Stop\/Restart\/Reset\/Set- that will change system state, it should support ShouldProcess attribute.<\/span><\/li>\n
    • AvoidUsingWMIObjectCmdlet – For PowerShell 3.0 and above, usage of WMIObject is not recommended. This rule is to detect WMIObject usage in scripts that are written for PS 3.0 and above.<\/span> <\/li>\n<\/ul>\n

      Fixes:<\/strong><\/span><\/pre>\n
        \n
      • Better heuristics to detect usage of Username and Password instead of PSCredential type<\/span><\/li>\n
      • Better accuracy in the detection of uninitialized variables<\/span><\/li>\n
      • Better error messages, added error line numbers and file names<\/span><\/li>\n
      • Identifying usage of PSBound parameters and PowerShell supplied variables such as $MyInvocation<\/span><\/li>\n
      • Fixed terminating errors including “Illegal characters in Path”<\/span><\/li>\n
      • Display properties in output are now consistent with the object properties so it would be easy to do property accessing<\/span> <\/li>\n<\/ul>\n
         <\/pre>\n
        Thanks,<\/span><\/pre>\n
        Raghu Shantha<\/span><\/pre>\n
        PowerShell ScriptAnalyzer Team<\/span><\/pre>\n","protected":false},"excerpt":{"rendered":"
        With the release of Windows Management Framework 5.0 April Preview, we are excited to announce that PowerShell ScriptAnalyzer development has moved to GitHub for greater collaboration & community involvement. https:\/\/github.com\/PowerShell\/PSScriptAnalyzer  Also, we have published v1.0 of ScriptAnalyzer to PSGallery. https:\/\/www.powershellgallery.com\/packages\/PSScriptAnalyzer\/  Here are the significant changes in this release:  Features: “Recursive” switch to analyze a folderpath […]<\/p>\n","protected":false},"author":600,"featured_media":13641,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[3182],"class_list":["post-1201","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-powershell","tag-psscriptanalyzer"],"acf":[],"blog_post_summary":"
        With the release of Windows Management Framework 5.0 April Preview, we are excited to announce that PowerShell ScriptAnalyzer development has moved to GitHub for greater collaboration & community involvement. https:\/\/github.com\/PowerShell\/PSScriptAnalyzer  Also, we have published v1.0 of ScriptAnalyzer to PSGallery. https:\/\/www.powershellgallery.com\/packages\/PSScriptAnalyzer\/  Here are the significant changes in this release:  Features: “Recursive” switch to analyze a folderpath […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/posts\/1201","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/users\/600"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/comments?post=1201"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/posts\/1201\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/media\/13641"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/media?parent=1201"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/categories?post=1201"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/tags?post=1201"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}