tdiary/tdiary-style-gfm

View on GitHub

Showing 3 of 5 total issues

Method append has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
Open

            def append(body, author = nil)
                in_code_block = false
                section = nil
                body.each_line do |l|
                    case l
Severity: Minor
Found in lib/tdiary/style/gfm.rb - About 2 hrs 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 to_html has 53 lines of code (exceeds 25 allowed). Consider refactoring.
Open

            def to_html(string)
                r = string.dup

                # 1. Stash plugin calls
                plugin_stashes = []
Severity: Major
Found in lib/tdiary/style/gfm.rb - About 2 hrs to fix

    Method to_html has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
    Open

                def to_html(string)
                    r = string.dup
    
                    # 1. Stash plugin calls
                    plugin_stashes = []
    Severity: Minor
    Found in lib/tdiary/style/gfm.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

    Severity
    Category
    Status
    Source
    Language