stevegrunwell/smee

View on GitHub

Showing 4 of 5 total issues

Method executeCommand has 50 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    protected function executeCommand($project, $io)
    {
        try {
            $project->copyHooks();
        } catch (HookExistsException $e) {
Severity: Minor
Found in src/Console/InstallCommand.php - About 2 hrs to fix

    Function executeCommand has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
    Open

        protected function executeCommand($project, $io)
        {
            try {
                $project->copyHooks();
            } catch (HookExistsException $e) {
    Severity: Minor
    Found in src/Console/InstallCommand.php - 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

    Function copyHook has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

        public function copyHook($hook, $force = false)
        {
            $hook = basename($hook);
            $path = $this->hooksDir . '/' . $hook;
            $dest = $this->baseDir . '/.git/hooks/' . $hook;
    Severity: Minor
    Found in src/Project.php - About 35 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

    The method executeCommand uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

                        } else {
                            $project->skipHook($e->getHook());
                        }
    Severity: Minor
    Found in src/Console/InstallCommand.php by phpmd

    ElseExpression

    Since: 1.4.0

    An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

    Example

    class Foo
    {
        public function bar($flag)
        {
            if ($flag) {
                // one branch
            } else {
                // another branch
            }
        }
    }

    Source https://phpmd.org/rules/cleancode.html#elseexpression

    Severity
    Category
    Status
    Source
    Language