actions-marketplace-validations/Run PSScriptAnalyzer
Run PSScriptAnalyzer
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| path | Specifies the path to the scripts or module to be analyzed. Wildcard characters are supported. | yes | .\ |
| customRulePath | Uses only the custom rules defined in the specified paths to the analysis. To still use the built-in rules, add the -IncludeDefaultRules switch. | no | — |
| recurseCustomRulePath | Adds rules defined in subdirectories of the CustomRulePath location. | no | — |
| excludeRule | Omits the specified rules from the Script Analyzer test. Wildcard characters are supported. | no | — |
| includeDefaultRules | Invoke default rules along with Custom rules. | no | — |
| includeRule | Runs only the specified rules in the Script Analyzer test. | no | — |
| severity | After running Script Analyzer with all rules, this parameter selects rule violations with the specified severity. | no | — |
| recurse | Runs Script Analyzer on the files in the Path directory and all subdirectories recursively. | no | — |
| suppressedOnly | Returns rules that are suppressed, instead of analyzing the files in the path. | no | — |
| fix | Fixes certain warnings which contain a fix in their DiagnosticRecord. | no | — |
| enableExit | Exits PowerShell and returns an exit code equal to the number of error records. | no | — |
| settings | File path that contains user profile or hash table for ScriptAnalyzer. | no | — |
| output | Specifies where the path for the sarif file | yes | results.sarif |
| ignorePattern | Exclude specific files from the sarif results. Uses regex pattern. | no | — |
Outputs
no outputs