DannyBen/bashly

View on GitHub
lib/bashly/config_validator.rb

Summary

Maintainability
A
0 mins
Test Coverage

Method assert_command has 60 lines of code (exceeds 25 allowed). Consider refactoring.
Wontfix

    def assert_command(key, value)
      assert_hash key, value, keys: Script::Command.option_keys

      refute value['commands'] && value['args'], "#{key} cannot have both nub`commands` and nub`args`"
      refute value['commands'] && value['catch_all'], "#{key} cannot have both nub`commands` and nub`catch_all`"
Severity: Major
Found in lib/bashly/config_validator.rb - About 2 hrs to fix

    Method assert_flag has 36 lines of code (exceeds 25 allowed). Consider refactoring.
    Wontfix

        def assert_flag(key, value)
          assert_hash key, value, keys: Script::Flag.option_keys
          assert value['short'] || value['long'], "#{key} must have at least one of nub`long` or nub`short`"
    
          refute value['allowed'] && value['completions'], "#{key} cannot have both nub`allowed` and nub`completions`"
    Severity: Minor
    Found in lib/bashly/config_validator.rb - About 1 hr to fix

      Method assert_flag has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
      Wontfix

          def assert_flag(key, value)
            assert_hash key, value, keys: Script::Flag.option_keys
            assert value['short'] || value['long'], "#{key} must have at least one of nub`long` or nub`short`"
      
            refute value['allowed'] && value['completions'], "#{key} cannot have both nub`allowed` and nub`completions`"
      Severity: Minor
      Found in lib/bashly/config_validator.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 assert_command has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
      Wontfix

          def assert_command(key, value)
            assert_hash key, value, keys: Script::Command.option_keys
      
            refute value['commands'] && value['args'], "#{key} cannot have both nub`commands` and nub`args`"
            refute value['commands'] && value['catch_all'], "#{key} cannot have both nub`commands` and nub`catch_all`"
      Severity: Minor
      Found in lib/bashly/config_validator.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