phug-php/watcher

View on GitHub

Showing 59 of 59 total issues

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

    public function run(array $cliArguments, $interval = 1000000, $timeout = null, callable $callback = null)
    {
        $watcher = new Watcher();

        $arguments = [];
Severity: Minor
Found in src/Phug/Watcher/Cli.php - About 5 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

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

    public function run(array $cliArguments, $interval = 1000000, $timeout = null, callable $callback = null)
    {
        $watcher = new Watcher();

        $arguments = [];
Severity: Major
Found in src/Phug/Watcher/Cli.php - About 2 hrs to fix

    Method getDocumentEvents has 29 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function getDocumentEvents($browserReloadPort)
        {
            if (!$browserReloadPort) {
                return [];
            }
    Severity: Minor
    Found in src/Phug/WatcherExtension.php - About 1 hr to fix

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

          public function getDocumentEvents($browserReloadPort)
          {
              if (!$browserReloadPort) {
                  return [];
              }
      Severity: Minor
      Found in src/Phug/WatcherExtension.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

      Method listen has 26 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public function listen()
          {
              $browserReloadPort = $this->browserReloadPort;
              $serverPort = intval($this->server);
              if ($serverPort) {
      Severity: Minor
      Found in src/Phug/PhugDevServer.php - About 1 hr to fix

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

                    throw new \RuntimeException('No watcher program found in the vendor/bin directory.');
        Severity: Minor
        Found in src/Phug/PhugDevServer.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

        Avoid too many return statements within this method.
        Open

                return $watcher->watch($arguments, $interval, $timeout, $callback);
        Severity: Major
        Found in src/Phug/Watcher/Cli.php - About 30 mins to fix

          Avoid using static access to class 'Phug\Phug' in method 'getOption'.
          Open

                      : (Phug::hasOption($name) ? Phug::getOption($name) : null)
          Severity: Minor
          Found in src/Phug/WatcherExtension.php by phpmd

          StaticAccess

          Since: 1.4.0

          Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

          Example

          class Foo
          {
              public function bar()
              {
                  Bar::baz();
              }
          }

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

          Avoid unused parameters such as '$resource'.
          Open

                      $watcher->setChangeEventCallback(function ($event, $resource, $path) use ($file, $options) {
          Severity: Minor
          Found in src/Phug/Watcher/Cli.php by phpmd

          UnusedFormalParameter

          Since: 0.2

          Avoid passing parameters to methods or constructors and then not using those parameters.

          Example

          class Foo
          {
              private function bar($howdy)
              {
                  // $howdy is not used
              }
          }

          Source https://phpmd.org/rules/unusedcode.html#unusedformalparameter

          Avoid unused parameters such as '$resource'.
          Open

                  $watcher->setChangeEventCallback(function ($event, $resource, $path) {
          Severity: Minor
          Found in src/Phug/WatcherExtension.php by phpmd

          UnusedFormalParameter

          Since: 0.2

          Avoid passing parameters to methods or constructors and then not using those parameters.

          Example

          class Foo
          {
              private function bar($howdy)
              {
                  // $howdy is not used
              }
          }

          Source https://phpmd.org/rules/unusedcode.html#unusedformalparameter

          Avoid unused parameters such as '$event'.
          Open

                  $watcher->setChangeEventCallback(function ($event, $resource, $path) {
          Severity: Minor
          Found in src/Phug/WatcherExtension.php by phpmd

          UnusedFormalParameter

          Since: 0.2

          Avoid passing parameters to methods or constructors and then not using those parameters.

          Example

          class Foo
          {
              private function bar($howdy)
              {
                  // $howdy is not used
              }
          }

          Source https://phpmd.org/rules/unusedcode.html#unusedformalparameter

          Avoid using static access to class 'Phug\Phug' in method 'getOption'.
          Open

                      : (Phug::hasOption($name) ? Phug::getOption($name) : null)
          Severity: Minor
          Found in src/Phug/WatcherExtension.php by phpmd

          StaticAccess

          Since: 1.4.0

          Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

          Example

          class Foo
          {
              public function bar()
              {
                  Bar::baz();
              }
          }

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

          Avoid unused parameters such as '$event'.
          Open

                      $watcher->setChangeEventCallback(function ($event, $resource, $path) use ($file, $options) {
          Severity: Minor
          Found in src/Phug/Watcher/Cli.php by phpmd

          UnusedFormalParameter

          Since: 0.2

          Avoid passing parameters to methods or constructors and then not using those parameters.

          Example

          class Foo
          {
              private function bar($howdy)
              {
                  // $howdy is not used
              }
          }

          Source https://phpmd.org/rules/unusedcode.html#unusedformalparameter

          Avoid unused parameters such as '$path'.
          Open

                      $watcher->setChangeEventCallback(function ($event, $resource, $path) use ($file, $options) {
          Severity: Minor
          Found in src/Phug/Watcher/Cli.php by phpmd

          UnusedFormalParameter

          Since: 0.2

          Avoid passing parameters to methods or constructors and then not using those parameters.

          Example

          class Foo
          {
              private function bar($howdy)
              {
                  // $howdy is not used
              }
          }

          Source https://phpmd.org/rules/unusedcode.html#unusedformalparameter

          Avoid using static access to class 'Phug\Phug' in method 'watch'.
          Open

                              return Phug::cacheFile($path);
          Severity: Minor
          Found in src/Phug/WatcherExtension.php by phpmd

          StaticAccess

          Since: 1.4.0

          Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

          Example

          class Foo
          {
              public function bar()
              {
                  Bar::baz();
              }
          }

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

          The method run() contains an exit expression.
          Open

                              exit(0);
          Severity: Minor
          Found in src/Phug/Watcher/Cli.php by phpmd

          ExitExpression

          Since: 0.2

          An exit-expression within regular code is untestable and therefore it should be avoided. Consider to move the exit-expression into some kind of startup script where an error/exception code is returned to the calling environment.

          Example

          class Foo {
              public function bar($param)  {
                  if ($param === 42) {
                      exit(23);
                  }
              }
          }

          Source https://phpmd.org/rules/design.html#exitexpression

          Avoid using static access to class 'Phug\Phug' in method 'getOption'.
          Open

                  $options = Phug::getOptions();
          Severity: Minor
          Found in src/Phug/WatcherExtension.php by phpmd

          StaticAccess

          Since: 1.4.0

          Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

          Example

          class Foo
          {
              public function bar()
              {
                  Bar::baz();
              }
          }

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

          The method run() has 100 lines of code. Current threshold is set to 100. Avoid really long methods.
          Open

              public function run(array $cliArguments, $interval = 1000000, $timeout = null, callable $callback = null)
              {
                  $watcher = new Watcher();
          
                  $arguments = [];
          Severity: Minor
          Found in src/Phug/Watcher/Cli.php by phpmd

          The method run() has an NPath complexity of 7830. The configured NPath complexity threshold is 200.
          Open

              public function run(array $cliArguments, $interval = 1000000, $timeout = null, callable $callback = null)
              {
                  $watcher = new Watcher();
          
                  $arguments = [];
          Severity: Minor
          Found in src/Phug/Watcher/Cli.php by phpmd

          NPathComplexity

          Since: 0.1

          The NPath complexity of a method is the number of acyclic execution paths through that method. A threshold of 200 is generally considered the point where measures should be taken to reduce complexity.

          Example

          class Foo {
              function bar() {
                  // lots of complicated code
              }
          }

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

          The method run() has a Cyclomatic Complexity of 19. The configured cyclomatic complexity threshold is 10.
          Open

              public function run(array $cliArguments, $interval = 1000000, $timeout = null, callable $callback = null)
              {
                  $watcher = new Watcher();
          
                  $arguments = [];
          Severity: Minor
          Found in src/Phug/Watcher/Cli.php by phpmd

          CyclomaticComplexity

          Since: 0.1

          Complexity is determined by the number of decision points in a method plus one for the method entry. The decision points are 'if', 'while', 'for', and 'case labels'. Generally, 1-4 is low complexity, 5-7 indicates moderate complexity, 8-10 is high complexity, and 11+ is very high complexity.

          Example

          // Cyclomatic Complexity = 11
          class Foo {
          1   public function example() {
          2       if ($a == $b) {
          3           if ($a1 == $b1) {
                          fiddle();
          4           } elseif ($a2 == $b2) {
                          fiddle();
                      } else {
                          fiddle();
                      }
          5       } elseif ($c == $d) {
          6           while ($c == $d) {
                          fiddle();
                      }
          7        } elseif ($e == $f) {
          8           for ($n = 0; $n < $h; $n++) {
                          fiddle();
                      }
                  } else {
                      switch ($z) {
          9               case 1:
                              fiddle();
                              break;
          10              case 2:
                              fiddle();
                              break;
          11              case 3:
                              fiddle();
                              break;
                          default:
                              fiddle();
                              break;
                      }
                  }
              }
          }

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

          Severity
          Category
          Status
          Source
          Language