iv-mexx/git-releaselog

View on GitHub

Showing 7 of 7 total issues

Method generate_releaselog has a Cognitive Complexity of 28 (exceeds 5 allowed). Consider refactoring.
Open

    def self.generate_releaselog(options = {})
    repo_path = options.fetch(:repo_path, '.')
    from_ref_name = options.fetch(:from_ref, nil).strip if options.fetch(:from_ref, nil)
    to_ref_name = options.fetch(:to_ref, nil).strip if options.fetch(:to_ref, nil)
    scope = options.fetch(:scope, nil)
Severity: Minor
Found in lib/git-releaselog.rb - About 4 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 generate_releaselog has 78 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    def self.generate_releaselog(options = {})
    repo_path = options.fetch(:repo_path, '.')
    from_ref_name = options.fetch(:from_ref, nil).strip if options.fetch(:from_ref, nil)
    to_ref_name = options.fetch(:to_ref, nil).strip if options.fetch(:to_ref, nil)
    scope = options.fetch(:scope, nil)
Severity: Major
Found in lib/git-releaselog.rb - About 3 hrs to fix

    Consider simplifying this complex logical expression.
    Open

        if generate_complete && repo.tags.count > 0
          sorted_tags = repo.tags.sort { |t1, t2| t1.target.time <=> t2.target.time }
          changeLogs = []
          sorted_tags.each_with_index do |tag, index|
            logger.info("Tag #{tag.name} with date #{tag.target.time}")
    Severity: Critical
    Found in lib/git-releaselog.rb - About 1 hr to fix

      Method available_options has 27 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

            def self.available_options
              [
                FastlaneCore::ConfigItem.new(key: :scope,
                                             env_name: "FL_CREATE_CHANGELOG_SCOPE",
                                             description: "The Project scope",
      Severity: Minor
      Found in fastlane/actions/create_changelog.rb - About 1 hr to fix

        Method initialize has 5 arguments (exceeds 4 allowed). Consider refactoring.
        Open

            def initialize(changes, tag_from = nil, tag_to = nil, from_commit = nil, to_commit = nil)
        Severity: Minor
        Found in lib/git-releaselog/changelog.rb - About 35 mins to fix

          Method searchGitLog has 5 arguments (exceeds 4 allowed). Consider refactoring.
          Open

          def searchGitLog(repo, commit_from, commit_to, scope, logger)
          Severity: Minor
          Found in lib/git-releaselog/changelog_helpers.rb - About 35 mins to fix

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

                def check_scope(scope = nil)
                  # If no scope is requested or the change has no scope include this change unchanged
                  return self unless scope
                  change_scope = /^\s*\[\w+\]/.match(@note)
                  return self unless change_scope
            Severity: Minor
            Found in lib/git-releaselog/change.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