Swift

Configuration - .deepsource.toml

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

name

• Type: String
• Presence: mandatory
• Description: Shortcode of the analyzer.
• Example:

name = "swift"

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]
  swift_version = "5.7"
  skip_doc_coverage = ["struct", "enum"]

swift_version

• Type: String
• Presence: optional
• Description: The version of Swift that is used by your project. This information is used by the analyzer to report issues only relevant for the mentioned version.
• Default Value: "5.8"
• Example:

[analyzers.meta]
  swift_version = "5.7"

skip_doc_coverage

• Type: Array
• Presence: optional
• Description: Specify which artifacts to skip when detecting documentation issues and calculating documentation coverage.
• Available Values: function, method, class, protocol, struct, enum
  • function - Ignore function definitions
  • method - Ignore method definitions
  • class - Ignore class definitions
  • protocol - Ignore protocol definitions
  • struct - Ignore struct definitions
  • enum - Ignore enum definitions
• Default Value: []
• Example:

skip_doc_coverage = ["class", "protocol"]

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:

[analyzers.meta]
cyclomatic_complexity_threshold = "very-high"

Sample config

version = 1

test_patterns = [
  "Tests/**",
  "*Tests.swift"
]

exclude_patterns = [
  ".build/**"
]

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

  [analyzers.meta]
  swift_version = "4.1"
  skip_doc_coverage = ["function", "method"]