> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coderabbit.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# PSScriptAnalyzer

> CodeRabbit's guide to PSScriptAnalyzer.

[PSScriptAnalyzer](https://github.com/PowerShell/PSScriptAnalyzer) is a static code checker for PowerShell scripts and modules. It checks script and module code for best-practice violations and common issues.

CodeRabbit runs PSScriptAnalyzer `v1.25.0`.

## Files

PSScriptAnalyzer runs on files with the following extensions:

* `.ps1` (PowerShell scripts)
* `.psm1` (PowerShell modules)
* `.psd1` (PowerShell data files / module manifests)

## Configuration

**enabled** `boolean` (default: true)

**Enable PSScriptAnalyzer**

> [tab] .coderabbit.yaml
>
> ```yaml .coderabbit.yaml theme={null}
> reviews:
>   tools:
>     psscriptanalyzer:
>       enabled: true
> ```

> [tab] Web UI
>
> In your organization or repository settings, go to **Reviews → Tools** and turn the tool on or off with its toggle.

## Links

* [PSScriptAnalyzer GitHub](https://github.com/PowerShell/PSScriptAnalyzer)
* [PSScriptAnalyzer documentation](https://learn.microsoft.com/en-us/powershell/utility-modules/psscriptanalyzer/overview?view=ps-modules)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.