DFE-Digital/govuk-components

View on GitHub

Showing 2 of 4 total issues

Method navigation_links has 41 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    def navigation_links
      {
        "Introduction" => {
          "Get started" => "/introduction/get-started/",
          "About ViewComponent" => "/introduction/about-viewcomponent/",
Severity: Minor
Found in guide/lib/helpers/link_helpers.rb - About 1 hr to fix

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

      def govuk_list(array = nil, type: nil, spaced: nil, classes: nil, html_attributes: {}, &block)
        type = type.to_s
    
        fail "Unrecognised type for govuk_list - should be :bullet or :number or nil" unless type.in?(["bullet", "number", ""])
    
    
    Severity: Minor
    Found in app/helpers/govuk_list_helper.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

    Severity
    Category
    Status
    Source
    Language