digipolisgent/robo-digipolis-code-validation

View on GitHub

Showing 13 of 13 total issues

The class PhpMd has 11 public methods. Consider refactoring PhpMd to keep number of public methods under 10.
Open

class PhpMd extends BaseTask
{

    /**
     * A php source code filename or directory.
Severity: Minor
Found in src/PhpMd.php by phpmd

TooManyPublicMethods

Since: 0.1

A class with too many public methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to have more fine grained objects.

By default it ignores methods starting with 'get' or 'set'.

Example

Source https://phpmd.org/rules/codesize.html#toomanypublicmethods

Method run has 56 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function run()
    {
        if (file_exists($this->dir . '/Gemfile')) {
            $bundle = $this->findExecutable('bundle');
            $this->processes[] = new Process(
Severity: Major
Found in src/ThemeValidate.php - About 2 hrs to fix

    Method run has 33 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function run()
        {
            if (empty($this->extensions)) {
                $this->extensions = ['php', 'inc'];
            }
    Severity: Minor
    Found in src/PhpMd.php - About 1 hr to fix

      Each class must be in a namespace of at least one level (a top-level vendor name)
      Open

      class RoboFile extends \Robo\Tasks
      Severity: Minor
      Found in RoboFile.php by phpcodesniffer

      Function digipolisPhpMd has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
      Open

          public function digipolisPhpMd(
              $opts = [
                  'dir' => null,
                  'format' => 'xml',
                  'extensions' => null,
      Severity: Minor
      Found in src/Commands/PhpMd.php - About 45 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 failOnViolations has a boolean flag argument $failOnViolations, which is a certain sign of a Single Responsibility Principle violation.
      Open

          public function failOnViolations($failOnViolations = true)
      Severity: Minor
      Found in src/PhpCs.php by phpmd

      BooleanArgumentFlag

      Since: 1.4.0

      A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

      Example

      class Foo {
          public function bar($flag = true) {
          }
      }

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

      Missing class import via use statement (line '237', column '23').
      Open

                  throw new \InvalidArgumentException(sprintf(
      Severity: Minor
      Found in src/PhpMd.php by phpmd

      MissingImport

      Since: 2.7.0

      Importing all external classes in a file through use statements makes them clearly visible.

      Example

      function make() {
          return new \stdClass();
      }

      Source http://phpmd.org/rules/cleancode.html#MissingImport

      The method failOnViolations has a boolean flag argument $failOnViolations, which is a certain sign of a Single Responsibility Principle violation.
      Open

          public function failOnViolations($failOnViolations = true)
      Severity: Minor
      Found in src/PhpMd.php by phpmd

      BooleanArgumentFlag

      Since: 1.4.0

      A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

      Example

      class Foo {
          public function bar($flag = true) {
          }
      }

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

      Function getCommand has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
      Open

          public function getCommand()
          {
      
              if (is_null($this->dir)) {
                  $projectRoot = $this->getConfig()->get('digipolis.root.project', null);
      Severity: Minor
      Found in src/PhpCs.php - 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

      Function digipolisPhpCs has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
      Open

          public function digipolisPhpCs(
              $opts = [
                  'dir' => null,
                  'standard' => 'PSR1,PSR2',
                  'extensions' => 'inc,php',
      Severity: Minor
      Found in src/Commands/PhpCs.php - 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

      Function run has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
      Open

          public function run()
          {
              if (file_exists($this->dir . '/Gemfile')) {
                  $bundle = $this->findExecutable('bundle');
                  $this->processes[] = new Process(
      Severity: Minor
      Found in src/ThemeValidate.php - 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

      Trait name "loadCommands" is not in camel caps format
      Open

      trait loadCommands

      Trait name "loadTasks" is not in camel caps format
      Open

      trait loadTasks
      Severity: Minor
      Found in src/loadTasks.php by phpcodesniffer
      Severity
      Category
      Status
      Source
      Language