Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks\LintAll

Complexity

Total Complexity

6

Size/Duplication

Total Lines	39
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getDescription()	0	3	1
A	hasCommitAndPush()	0	3	1
A	runActualTask()	0	15	3
A	getTitle()	0	3	1

<?php

namespace Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks;

use Sunnysideup\PHP2CommandLine\PHP2CommandLineSingleton;
use Sunnysideup\UpgradeToSilverstripe4\Api\FileSystemFixes;
use Sunnysideup\UpgradeToSilverstripe4\Tasks\Task;

/**
 * This task adds a legacy branch to the git repo of the original to act as a backup/legacy version for
 * holding a version of the module before it was changed
 */
class LintAll extends Task
{
    protected $taskStep = 's30';

    public function getTitle()
    {
        return 'Lint all php code.';
    }

    public function getDescription()
    {
        return '
            Goes through all the folders and uses the sake-lint-all function (this will need to be installed).';
    }

    /**
     * [runActualTask description]
     * @param  array  $params not currently used for this task
     */
    public function runActualTask($params = []): ?string
    {
        if(PHP2CommandLineSingleton::commandExists('sake-lint-all')) {
            foreach ($this->mu()->getExistingModuleDirLocations() as $moduleDir) {

It seems like getExistingModuleDirLocations() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                $this->mu()->execMe(

It seems like execMe() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                    $this->mu()->getWebRootDirLocation(),

The method getWebRootDirLocation() does not exist on Sunnysideup\UpgradeToSilverstripe4\ModuleUpgrader. Since you implemented __call, consider adding a @method annotation.

It seems like getWebRootDirLocation() must be provided by classes using this trait. How about adding it as abstract method to this trait?

It seems like $this->mu()->getWebRootDirLocation() can also be of type Sunnysideup\UpgradeToSilverstripe4\ModuleUpgrader and Sunnysideup\UpgradeToSilverstripe4\Traits\Creator and null; however, parameter $newDir of Sunnysideup\UpgradeToSilverstripe4\ModuleUpgrader::execMe() does only seem to accept string, maybe add an additional type check?

                    'sake-lint-all '.$moduleDir,
                    'Linting all PHP files in ' . $moduleDir,
                    true
                );
            }
        } else {
            return 'You need to install sake-lint-all to use this task: https://github.com/sunnysideup/silverstripe-easy-coding-standards';
        }
        return null;
    }

    protected function hasCommitAndPush()
    {
        return true;
    }
}