Cimpress-MCP/JustReleaseNotes

View on GitHub
JustReleaseNotes/command_line.py

Summary

Maintainability
A
3 hrs
Test Coverage

Function generate_release_notes has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring.
Open

def generate_release_notes(configFile):
        requests.packages.urllib3.disable_warnings()
        file = open(configFile, 'r')
        fileContents = file.read()
        releaseNotesConfig = EnvReplacer.replace(json.loads(fileContents))
Severity: Minor
Found in JustReleaseNotes/command_line.py - About 2 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

Function generateForOneWriter has 5 arguments (exceeds 4 allowed). Consider refactoring.
Open

def generateForOneWriter(generator, ticketProvider, writerType, directory, fileName):
Severity: Minor
Found in JustReleaseNotes/command_line.py - About 35 mins to fix

There are no issues that match your filters.

Category
Status