discorb-lib/discorb

View on GitHub
template-replace/scripts/yard_replace.rb

Summary

Maintainability
A
2 hrs
Test Coverage

Method yard_replace has 29 lines of code (exceeds 25 allowed). Consider refactoring.
Open

def yard_replace(dir, version)
  sha = `git rev-parse HEAD`.strip
  tag = `git describe --exact-match #{sha}`
  tag = tag.empty? ? "(main)" : tag.strip
  Dir.glob("#{dir}/**/*.html") do |file|
Severity: Minor
Found in template-replace/scripts/yard_replace.rb - About 1 hr to fix

    Method yard_replace has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
    Open

    def yard_replace(dir, version)
      sha = `git rev-parse HEAD`.strip
      tag = `git describe --exact-match #{sha}`
      tag = tag.empty? ? "(main)" : tag.strip
      Dir.glob("#{dir}/**/*.html") do |file|
    Severity: Minor
    Found in template-replace/scripts/yard_replace.rb - About 55 mins to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    There are no issues that match your filters.

    Category
    Status