Ruby beta

Configuration - .deepsource.toml

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

name

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

name = "ruby"

enabled

• Type: Boolean
• Presence: mandatory
• Description: Toggle whether this analyzer should be run.
• Example:

enabled = true

Sample config

version = 1

test_patterns = [
  "test/**",
  "*_test.rb"
]

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

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

TIP

Currently, Ruby 2.3 and above are supported. The Ruby version is detected from the .ruby-version file in your repository's root. If it .ruby-version file doesn't exist, we will fallback to Ruby 2.7 to detect issues.

Dependency installation

We install dependencies in your project in order to get a full picture of your code, and to reduce false positives.

Currently, we only support installation of dependencies from Gemfile.lock in repository's root, using the version of Bundler that was used to create your lock file. If dependency installation fails for some reason, the analysis will continue nevertheless.