Scala
Code Analysis
.deepsource.toml
This section covers .deepsource.toml
configuration specific to the scala
analyzer. Please make sure to read the general configuration guide first.
name
- Type: String
- Presence: mandatory
- Description: Shortcode of the analyzer.
- Example:
enabled
- Type: Boolean
- Presence: optional
- Description: Toggle whether this analyzer should be run.
- Example:
meta
- Type: Table
- Presence: optional
- Description: Any supported metadata to pass to the analyzer.
- Example:
cyclomatic_complexity_threshold
- Type: String
- Presence: optional
- Description: Specify the acceptable risk category for your project as the threshold. All functions with complexity beyond this threshold will raise an issue. For example, setting the threshold to
low
will flag all functions that have a cyclomatic complexity of more than5
, while setting the threshold tocritical
will not flag any function. - Available Values:
low
,medium
,high
,very-high
andcritical
Risk category | Cyclomatic complexity range | Recommended action |
---|---|---|
low | 1-5 | No action is needed. |
medium | 6-15 | Review and monitor. |
high | 16-25 | Review and refactor. Recommended to add detailed comments if the function absolutely needs to be kept as it is. |
very-high | 26-50 | Refactor to reduce the complexity. |
critical | >50 | Must refactor this. This can make the code untestable and very difficult to understand. |
- Default Value:
medium
- Example:
Sample config
Code Coverage
Jacoco
Add sbt-jacoco
to your project by adding the following line to your project/plugins.sbt
:
Then run sbt jacoco
to generate the coverage report. By default, you’ll find the report in /target/scala-{version}/jacoco/report
.
Note: To customize Jacoco’s coverage behavior, you’ll need to make changes to your build.sbt
. Refer to Jacoco’s documentation for more information.
Once you have a coverage report, you can upload it to DeepSource with the following commands:
Cobertura
You can also use Cobertura format coverage reports with the Scala analyzer. Generate your Cobertura report according to your build setup, then submit it using similar steps to the Jacoco example above.
Code Formatter (Transformer)
scalafmt
Transform all incoming Scala code with scalafmt, the official Scala code formatter.
This section covers .deepsource.toml
configuration specific to the scalafmt
transformer. Please make sure to read the general configuration guide first.
name
- Type: String
- Presence: mandatory
- Description: Shortcode of this transformer.
- Example:
enabled
- Type: Boolean
- Presence: optional
- Description: Toggle whether this transformer should be run.
- Example:
Sample transformer config
Vulnerability Scanning
Vulnerability scanning is not supported for the Scala at this time.