adobe/brackets

View on GitHub
src/LiveDevelopment/Inspector/jsdoc.rb

Summary

Maintainability
B
4 hrs
Test Coverage

Method writeDocument has 65 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    def writeDocument
        @out.write <<-eos
<!DOCTYPE html>
<html>
<head>
Severity: Major
Found in src/LiveDevelopment/Inspector/jsdoc.rb - About 2 hrs to fix

    Method typedef has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
    Open

        def typedef(domain, info)
            return "[" + typedef(domain, info['items']) + "]" if info['items']
            if info["$ref"]
                ref = info["$ref"]
                ref = domain + "." + ref unless ref =~ /\./
    Severity: Minor
    Found in src/LiveDevelopment/Inspector/jsdoc.rb - About 1 hr 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

    Method writeParams has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

        def writeParams(domain, params, prefixLine = false)
            return unless params
            write prefixLine if prefixLine
            write "<dl>"
            params.each do |p|
    Severity: Minor
    Found in src/LiveDevelopment/Inspector/jsdoc.rb - About 35 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

    Method writeTOCDomain has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

        def writeTOCDomain(info)
            domain = info["domain"]
            unless info["types"].empty?
                write "<span class='label'>Type</span>", "<ul>"
                info["types"].each { |p| writeTOCLine domain, p }
    Severity: Minor
    Found in src/LiveDevelopment/Inspector/jsdoc.rb - About 25 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