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: 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]
    skip_doc_coverage = ["module", "class"]

skip_doc_coverage

  • Type: Array

  • Presence: optional

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

  • Available Values: class, module, method, singleton_method

  • class - Ignore documentation coverage for class definitions

  • module - Ignore documentation coverage for module definitions

  • method - Ignore documentation coverage for method definitions

  • singleton_method - Ignore documentation coverage for singleton method definitions

  • Default Value: []

  • Example:

skip_doc_coverage = ["module", "singleton_method"]

Sample config

version = 1

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

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

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

  [analyzers.meta]
  skip_doc_coverage = ["module", "singleton_method"]

📘

We currently support Ruby 2.0 and above.


What’s Next