Skip to content

Generic/CyclomaticComplexity: improve error message #743

Open
@rodrigoprimo

Description

@rodrigoprimo

Is your feature request related to a problem?

Both the warning and the error message displayed by the Generic.Metrics.CyclomaticComplexity sniff could be improved if they included the name of the function that caused the error.

Describe the solution you'd like

Currently, the sniff displays the following error messages:

  72 | WARNING | Function's cyclomatic complexity (20) exceeds 10; consider refactoring the function
 118 | ERROR   | Function's cyclomatic complexity (21) exceeds allowed maximum of 20

I'm suggesting we update them to something like (note that I also added "the" before "allowed maximum"):

  72 | WARNING | Function complexityTwenty()'s cyclomatic complexity (20) exceeds 10; consider refactoring the function
 118 | ERROR   | Function complexityTwentyOne()'s cyclomatic complexity (21) exceeds allowed maximum of 20

Additional context (optional)

Below there are links to the places where the two messages are defined:

$error = 'Function\'s cyclomatic complexity (%s) exceeds allowed maximum of %s';

$warning = 'Function\'s cyclomatic complexity (%s) exceeds %s; consider refactoring the function';

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions