# sonarScan

Run static code analysis using Sonar Scanner

## Parameters

| Name                 | Description                                                                                                                      | Type      | Default                        | Required |
|----------------------|----------------------------------------------------------------------------------------------------------------------------------|-----------|--------------------------------|----------|
| additionalProperties | Map of additional Sonar scanner properties passed as `-Dkey=value` flags. Use to set any scanner option not covered by the named parameters. | `Map`     | `[:]`                          | no       |
| exclusions           | Regex containing excluded directories or files                                                                                   | `string`  | `'dev/**,fargate/**,tests/**'` | no       |
| language             | Project language                                                                                                                 | `string`  | n/a                            | yes      |
| project              | Name of project, typically application or repository name                                                                        | `string`  | n/a                            | yes      |
| projectBaseDir       | Optional subdirectory to scope the scan to                                                                                       | `string`  | ""                             | no       |
| qualityGateWait      | Whether or not to wait for a successful quality gate result. If `false`, a quality gate failure will not cause the step to fail. | `boolean` | `true`                         | no       |
| qualityGateTimeout   | The timeout in seconds when waiting for the quality gate                                                                         | `int`     | 60                             | no       |
| codeOwnerFileDir     | Optional directory where the CODEOWNERS file is located. This directory and any subdirectory named `.github` will be searched    | `string`  | Current workspace directory    | no       |