Swift

​

Code Analysis

​

.deepsource.toml

This section covers .deepsource.toml configuration specific to the swift analyzer. Please make sure to 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:

[analyzers.meta]
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"]

​

Code Coverage

The Swift analyzer supports LCOV format coverage reports. Here’s how to generate and report a coverage report:

# Run the tests
swift test --enable-code-coverage

# Generate a coverage report in LCOV format using llvm-cov
# Here, the coverage data is being written to a file named 'info.lcov'
llvm-cov export -format="lcov" </path/to/YourProjectPackageTests.xctest> -instr-profile </path/to/default.profdata> > info.lcov

# Install 'deepsource CLI'
curl https://deepsource.io/cli | sh

# Set DEEPSOURCE_DSN env variable from repository settings page
export DEEPSOURCE_DSN=https://sampledsn@deepsource.io

# From the root directory, run the report coverage command
./bin/deepsource report --analyzer test-coverage --key swift --value-file info.lcov

​

Code Formatter (Transformer)

​

swift-format

Transform all incoming Swift code with swift-format, a tool for formatting Swift code.

This section covers .deepsource.toml configuration specific to the swift-format transformer. Please make sure to read the general configuration guide first.

​

name

• Type: String
• Presence: mandatory
• Description: Shortcode of this transformer.
• Example:

name = "swift-format"

​

enabled

• Type: Boolean
• Presence: optional
• Description: Toggle whether this transformer should be run.
• Example:

enabled = true

​

Sample transformer config

[[transformers]]
name = "swift-format"
enabled = true

​

Vulnerability Scanning

Vulnerability scanning is not supported for Swift projects at this time.