Configuration - .deepsource.toml

This section covers configuration specific to the rust analyzer. Please make sure you read the general configuration guide first.

name

  • Type: String
  • Presence: mandatory
  • Description: Shortcode of the analyzer.
  • Example:
name = "rust"

enabled

  • Type: Boolean
  • Presence: optional
  • Description: Toggle whether this analyzer should be run.
  • Example:
enabled = true

meta

  • Type: Table
  • Presence: optional
  • Description: Any supported metadata to pass to the analyzer.
  • Example:
[analyzers.meta]
  msrv = "1.25.0"

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:
msrv = "1.58.1"
# or, for match against just 1.58 versions in general
msrv = "1.58"
# or, just stable to support the latest
# available release of rust on stable channel.
msrv = "stable"

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:

skip_doc_coverage = ["module", "trait"]

track_test_doc_coverage

  • Type: Boolean
  • Presence: optional
  • Description: Toggle whether documentation coverage should be reported for test files.
  • Default Value: false
  • Example:
# The default configuration
track_test_doc_coverage = false
# Enable docs coverage for test files
track_test_doc_coverage = true

Sample config

version = 1

test_patterns = [
  "tests/**"
]

exclude_patterns = [
  "**/examples/**"
]

[[analyzers]]
name = "rust"
enabled = true

  [analyzers.meta]
  msrv = "stable"

📘

We currently support Rust 1.25.0 and above in the stable channel but not nightly or beta channels.


What’s Next