Sign upLogin

metanorma/metanorma-cli

View on GitHub
Star

Showing 3 of 3 total issues

Class Command has 21 methods (exceeds 20 allowed). Consider refactoring.
Open

    class Command < ThorWithConfig
      class_option :progress, aliases: "-s", type: :boolean, default: false,
                              desc: "Show progress for long running tasks (like download)"

      desc "new NAME", "Create new Metanorma document"
Severity: Minor
Found in lib/metanorma/cli/command.rb - About 2 hrs to fix

    Method run has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
    Open

          def run
        if Cli.writable_templates_path?
          if name && document_path.exist?
            return unless overwrite?(document_path)
    Severity: Minor
    Found in lib/metanorma/cli/generator.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 compile has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

          def compile(file_name = nil)
        if file_name && !options[:version]
          documents = select_wildcard_documents(file_name) || [file_name]
          documents.each { |document| compile_document(document, options.dup) }
    Severity: Minor
    Found in lib/metanorma/cli/command.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