Configuration - .deepsource.toml

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

name

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

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]
  bootstrap_files = ["config/bootstrap.php"]

bootstrap_files

  • Type: Array
  • Presence: optional
  • Description: List of files that your project is using to define global constants, custom autoloader, class aliases, etc. This will help reduce the false positives.
  • Example:
bootstrap_files = ["config/bootstrap.php"]

skip_doc_coverage

  • Type: Array

  • Presence: optional

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

  • Available Values: class, magic and nonpublic

    • class - Ignore docstrings of class definitions
    • magic - Ignore docstrings of magic methods
    • nonpublic - Ignore docstrings for non-public(protected and private) methods
  • Default Value: ["magic"]

  • Example:

skip_doc_coverage = ["class", "magic", "nonpublic"]

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

Risk categoryCyclomatic complexity rangeRecommended action
low1-5No action is needed.
medium6-15Review and monitor.
high16-25Review and refactor. Recommended to add detailed comments if the function absolutely needs to be kept as it is.
very-high26-50Refactor to reduce the complexity.
critical>50Must refactor this. This can make the code untestable and very difficult to understand.
  • Default Value: medium
  • Example:
[analyzers.meta]
cyclomatic_complexity_threshold = "high"

Sample config

version = 1

test_patterns = [
  "**/tests/**"
]

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

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

  [analyzers.meta]
  bootstrap_files = ["config/bootstrap.php"]
  skip_doc_coverage = ["class", "magic", "nonpublic"]

๐Ÿ“˜

We currently support PHP 7 and 8.