Sign upLogin

rrrene/inch

View on GitHub
Star

Showing 23 of 58 total issues

Avoid too many return statements within this method.
Open

                    return parent.implicit_nodoc_all_comment?
Severity: Major
Found in lib/inch/language/ruby/provider/yard/nodoc_helper.rb - About 30 mins to fix

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

          def expand_files(files)
        files.map do |f|
          case f
          when String
            f =~ /[\*\{]/ ? Dir[f] : f
    Severity: Minor
    Found in lib/inch/config/codebase.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

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

              def relevant_base_roles
            {
              Role::Object::InRoot => nil,
              Role::Object::Public => nil,
              Role::Object::Protected => nil,
    Severity: Minor
    Found in lib/inch/language/ruby/evaluation/base.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