Title: `Invoke-ScriptAnalyzer` `-Severity` filters rules rather than diagnostics · Issue #2156 · PowerShell/PSScriptAnalyzer · GitHub
Open Graph Title: `Invoke-ScriptAnalyzer` `-Severity` filters rules rather than diagnostics · Issue #2156 · PowerShell/PSScriptAnalyzer
X Title: `Invoke-ScriptAnalyzer` `-Severity` filters rules rather than diagnostics · Issue #2156 · PowerShell/PSScriptAnalyzer
Description: The -Severity parameter of Invoke-ScriptAnalyzer does not do what it says it does. Parameter help for the -Severity parameter says: After running Script Analyzer with all rules, this parameter selects rule violations with the specified s...
Open Graph Description: The -Severity parameter of Invoke-ScriptAnalyzer does not do what it says it does. Parameter help for the -Severity parameter says: After running Script Analyzer with all rules, this parameter sele...
X Description: The -Severity parameter of Invoke-ScriptAnalyzer does not do what it says it does. Parameter help for the -Severity parameter says: After running Script Analyzer with all rules, this parameter sele...
Opengraph URL: https://github.com/PowerShell/PSScriptAnalyzer/issues/2156
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"`Invoke-ScriptAnalyzer` `-Severity` filters rules rather than diagnostics","articleBody":"The `-Severity` parameter of `Invoke-ScriptAnalyzer` does not do what it says it does.\n\nParameter help for the `-Severity` parameter says:\n\n> *After running Script Analyzer with all rules, this parameter selects rule violations with the specified severity.\n> ...\n> The parameter filters the rules violations only after running all rules.\n> ...*\n\nIn reality the parameter filters **rules** and not **diagnostics**; both have the concept of Severity ([`RuleSeverity`](https://github.com/PowerShell/PSScriptAnalyzer/blob/aba29c31151925bd7180e7dfd578e1bfacdaf2a2/Engine/Generic/RuleSeverity.cs#L9-L30), and [`DiagnosticSeverity`](https://github.com/PowerShell/PSScriptAnalyzer/blob/aba29c31151925bd7180e7dfd578e1bfacdaf2a2/Engine/Generic/DiagnosticRecord.cs#L145C1-L166C7))\n\n---\n\nHow the `-Severity` parameter is ultimately used:\n\n1. The user [passes `-Severity`](https://github.com/PowerShell/PSScriptAnalyzer/blob/aba29c31151925bd7180e7dfd578e1bfacdaf2a2/Engine/Commands/InvokeScriptAnalyzerCommand.cs#L148-L159) to `Invoke-ScriptAnalyzer`. Value validated to be one of `\"Warning\", \"Error\", \"Information\", \"ParseError\"`.\n \n2. The `ScriptAnalyzer` singleton instance is [initialised with this `-Severity` `string[]`](https://github.com/PowerShell/PSScriptAnalyzer/blob/aba29c31151925bd7180e7dfd578e1bfacdaf2a2/Engine/Commands/InvokeScriptAnalyzerCommand.cs#L367C17-L367C31) value, which is [stored as a private member](https://github.com/PowerShell/PSScriptAnalyzer/blob/aba29c31151925bd7180e7dfd578e1bfacdaf2a2/Engine/ScriptAnalyzer.cs#L49C9-L49C27) of the singleton object (`severity`).\n\n3. When analyzing a script, the engine determines which rules to run. It uses [`IsRuleAllowed()`](https://github.com/PowerShell/PSScriptAnalyzer/blob/aba29c31151925bd7180e7dfd578e1bfacdaf2a2/Engine/ScriptAnalyzer.cs#L1947-L1977) to check each rule.\n\n4. `IsRuleAllowed()` gets a list of `allowedSeverities`. It does so by calling `GetAllowedSeveritiesInInt()`.\n\n Each `severity` (an array of strings) is parsed into the underlying `uint` value of the `DiagnosticSeverity` enum type.\n\n > _(I believe this should actually be `RuleSeverity` enum. It works as both enums have identical members and underlying `uint` values)_.\n https://github.com/PowerShell/PSScriptAnalyzer/blob/aba29c31151925bd7180e7dfd578e1bfacdaf2a2/Engine/ScriptAnalyzer.cs#L1929-L1934\n\n5. `IsRuleAllowed()` then calls `IsSeverityAllowed(allowedSeverities, rule)` as part of it's decision making on whether to execute a rule. Passing in the list of `allowedSeverities` and the current `rule` being considered.\n\n6. `IsSeverityAllowed(..)` then checks if `allowedSeverities` contains the `rule`s severity (calling `rule.GetSeverity()` and casting it to a `uint`). If it does the rule is allowed to run.\n https://github.com/PowerShell/PSScriptAnalyzer/blob/aba29c31151925bd7180e7dfd578e1bfacdaf2a2/Engine/ScriptAnalyzer.cs#L1914-L1921\n\n---\n\nSo there are 2 issues that need to be addressed:\n\n1. There is a disparity between the documentation and implementation. Either:\n - The documentation needs updating to match reality OR\n - The implementation needs to be updated so `-Severity` filters the output of `DiagnosticRecord`s.\n\n2. `GetAllowedSeveritiesInInt()` resolves severities using `DiagnosticSeverity` and that is then used to compare to `rule.GetSeverity()` which is a `RuleSeverity`. It works now as both enums are identical in their definition and are being cast to their underlying `uint` value. If either was updated this could break. It also does not seem intentional.\n\n@bergmeister - Should we update the documentation as a first pass and revisit behaviour later if it's desired? I will also get the enum corrected to `RuleSeverity`.\n\nThis explains the issue described in #2049 - where a custom rule is emitting error-level `DiagnosticRecord` but is not showing with `-Severity Error`, but is with `-Severity Warning`. `-Severity` is filtering the rules that are run (by their severity) and all custom rules have `Warning` severity.\n\nhttps://github.com/PowerShell/PSScriptAnalyzer/blob/aba29c31151925bd7180e7dfd578e1bfacdaf2a2/Engine/Generic/ExternalRule.cs#L55-L59\n\n_**n.b.** I have typed the word severity so many times now that it no longer looks like a real word..._","author":{"url":"https://github.com/liamjpeters","@type":"Person","name":"liamjpeters"},"datePublished":"2026-02-20T18:05:58Z","url":"https://github.com/PowerShell/PSScriptAnalyzer/issues/2156"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:a69629f6-71b7-747c-725a-2ceeffa65947 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | BF3C:13EF97:174081:20493B:6AFCDF79 |
| html-safe-nonce | 8984a6d29ce38eed08c9acb3e4cc44682a9d00242af1ef9636f867a09d4e2400 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCRjNDOjEzRUY5NzoxNzQwODE6MjA0OTNCOjZBRkNERjc5IiwidmlzaXRvcl9pZCI6IjgyODU4Mjg0NzY2MjM5NzAxNzAiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 8705b70037213f41f45bd1b91f0153a5f2e8ca526c761abe5f277d2d0edce8b5 |
| hovercard-subject-tag | issue:3969735682 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/PowerShell/PSScriptAnalyzer/2156/issue_layout |
| twitter:image | https://opengraph.githubassets.com/28be22967bb9419c02552557470de15d9678a1ce33d6a9608fc6ab187f0ada07/PowerShell/PSScriptAnalyzer/issues/2156 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/28be22967bb9419c02552557470de15d9678a1ce33d6a9608fc6ab187f0ada07/PowerShell/PSScriptAnalyzer/issues/2156 |
| og:image:alt | The -Severity parameter of Invoke-ScriptAnalyzer does not do what it says it does. Parameter help for the -Severity parameter says: After running Script Analyzer with all rules, this parameter sele... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | liamjpeters |
| hostname | github.com |
| expected-hostname | github.com |
| None | 0c05b7eb5b95e29725d01bb1f560a020e3fafd0f033c6b9ed3918fa3161254dd |
| turbo-cache-control | no-preview |
| go-import | github.com/PowerShell/PSScriptAnalyzer git https://github.com/PowerShell/PSScriptAnalyzer.git |
| octolytics-dimension-user_id | 11524380 |
| octolytics-dimension-user_login | PowerShell |
| octolytics-dimension-repository_id | 33149177 |
| octolytics-dimension-repository_nwo | PowerShell/PSScriptAnalyzer |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 33149177 |
| octolytics-dimension-repository_network_root_nwo | PowerShell/PSScriptAnalyzer |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 79d9154e55368884c8c93766ba4fee076343d37f |
| ui-target | canary-2 |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width