This section covers configuration specific to the ruby
analyzer.
This section covers .deepsource.toml
configuration specific to the go
analyzer. Please make sure to read the general configuration guide first.
name
enabled
meta
skip_doc_coverage
class
, module
, method
, singleton_method
class
- Ignore documentation coverage for class definitionsmodule
- Ignore documentation coverage for module definitionsmethod
- Ignore documentation coverage for method definitionssingleton_method
- Ignore documentation coverage for singleton method definitionscyclomatic_complexity_threshold
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.low
, medium
, high
, very-high
and critical
Risk category | Cyclomatic complexity range | Recommended action |
---|---|---|
low | 1-5 | No action is needed. |
medium | 6-15 | Review and monitor. |
high | 16-25 | Review and refactor. Recommended to add detailed comments if the function absolutely needs to be kept as it is. |
very-high | 26-50 | Refactor to reduce the complexity. |
critical | >50 | Must refactor this. This can make the code untestable and very difficult to understand. |
medium
We currently support Ruby 2.0 and above.
First, install simplecov
if it is not already installed:
Follow these steps to generate a test coverage report:
spec_helper.rb
file inside the tests
folder of your project:--require spec_helper.rb
to the .rspec
file.bundle exec rake rspec
to generate a coverage report.coverage
folder.Once you have a coverage report, you can upload it to DeepSource:
SimpleCov writes coverage results to a .resultset.json
file. This is what you need to upload to DeepSource.
Format all incoming Ruby code with RuboCop.
This section covers .deepsource.toml
configuration specific to the rubocop
transformer. Please make sure to read the general configuration guide first.
Format all incoming Ruby code with StandardRB.
This section covers .deepsource.toml
configuration specific to the standardrb
transformer. Please make sure to read the general configuration guide first.
Supported target files:
Gemfile
Gemfile.lock
This section covers configuration specific to the ruby
analyzer.
This section covers .deepsource.toml
configuration specific to the go
analyzer. Please make sure to read the general configuration guide first.
name
enabled
meta
skip_doc_coverage
class
, module
, method
, singleton_method
class
- Ignore documentation coverage for class definitionsmodule
- Ignore documentation coverage for module definitionsmethod
- Ignore documentation coverage for method definitionssingleton_method
- Ignore documentation coverage for singleton method definitionscyclomatic_complexity_threshold
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.low
, medium
, high
, very-high
and critical
Risk category | Cyclomatic complexity range | Recommended action |
---|---|---|
low | 1-5 | No action is needed. |
medium | 6-15 | Review and monitor. |
high | 16-25 | Review and refactor. Recommended to add detailed comments if the function absolutely needs to be kept as it is. |
very-high | 26-50 | Refactor to reduce the complexity. |
critical | >50 | Must refactor this. This can make the code untestable and very difficult to understand. |
medium
We currently support Ruby 2.0 and above.
First, install simplecov
if it is not already installed:
Follow these steps to generate a test coverage report:
spec_helper.rb
file inside the tests
folder of your project:--require spec_helper.rb
to the .rspec
file.bundle exec rake rspec
to generate a coverage report.coverage
folder.Once you have a coverage report, you can upload it to DeepSource:
SimpleCov writes coverage results to a .resultset.json
file. This is what you need to upload to DeepSource.
Format all incoming Ruby code with RuboCop.
This section covers .deepsource.toml
configuration specific to the rubocop
transformer. Please make sure to read the general configuration guide first.
Format all incoming Ruby code with StandardRB.
This section covers .deepsource.toml
configuration specific to the standardrb
transformer. Please make sure to read the general configuration guide first.
Supported target files:
Gemfile
Gemfile.lock