Rust

​

Configuration - .deepsource.toml

Please make sure you 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:

​

msrv

• Type: String
• Presence: optional
• Description: Minimum supported Rust version that your project builds against. Note: we don’t support nightly Rust releases.
• Default Value: "stable"
• Example:

​

skip_doc_coverage

• Type: Array

• Presence: optional

• Description: Specify which artifacts to skip when calculating documentation coverage.

• Available Values: const, struct, union, enum, function, module, static, trait, and type-alias

• const - Ignore documentation coverage for const items

• struct - Ignore documentation coverage for structs

• union - Ignore documentation coverage for unions

• enum - Ignore documentation coverage for enums

• function - Ignore documentation coverage for functions

• module - Ignore documentation coverage for modules

• static - Ignore documentation coverage for static items

• trait - Ignore documentation coverage for traits

• type-alias - Ignore documentation coverage for type aliases

• Default Value: []

• Example:

​

track_test_doc_coverage

• Type: Boolean
• Presence: optional
• Description: Toggle whether documentation coverage should be reported for test files.
• Default Value: false
• 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 than 5, while setting the threshold to critical will not flag any function.

• Available Values: low, medium, high, very-high and critical

• Default Value: high
• Example:

​

Sample config