src/Phan/Config/Initializer.php

Summary

Maintainability
F
4 days
Test Coverage

File Initializer.php has 453 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

declare(strict_types=1);

namespace Phan\Config;
Severity: Minor
Found in src/Phan/Config/Initializer.php - About 6 hrs to fix

    Method createPhanSettingsForComposerSettings has 140 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public static function createPhanSettingsForComposerSettings(array $composer_settings, ?string $vendor_path, array $opts): InitializedSettings
        {
            $level = $opts['init-level'] ?? 3;
            $level = self::LEVEL_MAP[\strtolower((string)$level)] ?? $level;
            if (\filter_var($level, FILTER_VALIDATE_INT) === false) {
    Severity: Major
    Found in src/Phan/Config/Initializer.php - About 5 hrs to fix

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

          public static function createPhanSettingsForComposerSettings(array $composer_settings, ?string $vendor_path, array $opts): InitializedSettings
          {
              $level = $opts['init-level'] ?? 3;
              $level = self::LEVEL_MAP[\strtolower((string)$level)] ?? $level;
              if (\filter_var($level, FILTER_VALIDATE_INT) === false) {
      Severity: Minor
      Found in src/Phan/Config/Initializer.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

      The class Initializer has an overall complexity of 90 which is very high. The configured complexity threshold is 50.
      Open

      class Initializer
      {
          /**
           * @param array{init-overwrite?:mixed,init-no-composer?:mixed,init-level?:(int|string)} $opts
           * Returns
      Severity: Minor
      Found in src/Phan/Config/Initializer.php by phpmd

      Function generateEntrySnippetForSetting has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring.
      Open

          public static function generateEntrySnippetForSetting(string $setting_name, $setting_value, array $additional_comment_lines): string
          {
              $source = self::generateCommentForSetting($setting_name);
              foreach ($additional_comment_lines as $line) {
                  $source .= "    // $line\n";
      Severity: Minor
      Found in src/Phan/Config/Initializer.php - About 2 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

      Function extractAutoloadFilesAndDirectories has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
      Open

          private static function extractAutoloadFilesAndDirectories(string $relative_dir, array $composer_settings): array
          {
              $directory_list = [];
              $file_list = [];
              $autoload_setting = $composer_settings['autoload'] ?? [];
      Severity: Minor
      Found in src/Phan/Config/Initializer.php - About 2 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

      Function initPhanConfig has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
      Open

          public static function initPhanConfig(array $opts): void
          {
              Config::setValue('use_polyfill_parser', true);
              $cwd = \getcwd();
      
      
      Severity: Minor
      Found in src/Phan/Config/Initializer.php - About 2 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 initPhanConfig has 40 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public static function initPhanConfig(array $opts): void
          {
              Config::setValue('use_polyfill_parser', true);
              $cwd = \getcwd();
      
      
      Severity: Minor
      Found in src/Phan/Config/Initializer.php - About 1 hr to fix

        Method generateEntrySnippetForSetting has 37 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            public static function generateEntrySnippetForSetting(string $setting_name, $setting_value, array $additional_comment_lines): string
            {
                $source = self::generateCommentForSetting($setting_name);
                foreach ($additional_comment_lines as $line) {
                    $source .= "    // $line\n";
        Severity: Minor
        Found in src/Phan/Config/Initializer.php - About 1 hr to fix

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

              private static function extractAutoloadFilesAndDirectories(string $relative_dir, array $composer_settings): array
              {
                  $directory_list = [];
                  $file_list = [];
                  $autoload_setting = $composer_settings['autoload'] ?? [];
          Severity: Minor
          Found in src/Phan/Config/Initializer.php - About 1 hr to fix

            Method isPHPBinary has 32 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                public static function isPHPBinary(string $relative_path): bool
                {
                    $cwd = \getcwd();
                    $absolute_path = "$cwd/$relative_path";
                    if (!\file_exists($absolute_path)) {
            Severity: Minor
            Found in src/Phan/Config/Initializer.php - About 1 hr to fix

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

                  public static function determineTargetPHPVersion(array $composer_settings): array
                  {
                      $php_version_constraint = $composer_settings['require']['php'] ?? null;
                      if (!$php_version_constraint || !is_string($php_version_constraint)) {
                          return [null, ['TODO: Choose a target_php_version for this project, or leave as null and remove this comment']];
              Severity: Minor
              Found in src/Phan/Config/Initializer.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 computeCommentNameDocumentationMap has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
              Open

                  public static function computeCommentNameDocumentationMap(): array
                  {
                      // Hackish way of extracting comment lines from Config::DEFAULT_CONFIGURATION
                      // @phan-suppress-next-line PhanPossiblyFalseTypeArgumentInternal
                      $config_file_lines = \explode("\n", \file_get_contents(\dirname(__DIR__) . '/Config.php'));
              Severity: Minor
              Found in src/Phan/Config/Initializer.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

              Avoid too many return statements within this method.
              Open

                          return $node->kind !== \ast\AST_ECHO || !is_string($node->children['expr']);
              Severity: Major
              Found in src/Phan/Config/Initializer.php - About 30 mins to fix

                Avoid too many return statements within this method.
                Open

                            return false;
                Severity: Major
                Found in src/Phan/Config/Initializer.php - About 30 mins to fix

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

                      public static function isPHPBinary(string $relative_path): bool
                      {
                          $cwd = \getcwd();
                          $absolute_path = "$cwd/$relative_path";
                          if (!\file_exists($absolute_path)) {
                  Severity: Minor
                  Found in src/Phan/Config/Initializer.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

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

                      public static function createPhanSettingsForComposerSettings(array $composer_settings, ?string $vendor_path, array $opts): InitializedSettings
                      {
                          $level = $opts['init-level'] ?? 3;
                          $level = self::LEVEL_MAP[\strtolower((string)$level)] ?? $level;
                          if (\filter_var($level, FILTER_VALIDATE_INT) === false) {
                  Severity: Minor
                  Found in src/Phan/Config/Initializer.php by phpmd

                  The method createPhanSettingsForComposerSettings() has an NPath complexity of 1166400. The configured NPath complexity threshold is 200.
                  Open

                      public static function createPhanSettingsForComposerSettings(array $composer_settings, ?string $vendor_path, array $opts): InitializedSettings
                      {
                          $level = $opts['init-level'] ?? 3;
                          $level = self::LEVEL_MAP[\strtolower((string)$level)] ?? $level;
                          if (\filter_var($level, FILTER_VALIDATE_INT) === false) {
                  Severity: Minor
                  Found in src/Phan/Config/Initializer.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 initPhanConfig() has a Cyclomatic Complexity of 10. The configured cyclomatic complexity threshold is 10.
                  Open

                      public static function initPhanConfig(array $opts): void
                      {
                          Config::setValue('use_polyfill_parser', true);
                          $cwd = \getcwd();
                  
                  
                  Severity: Minor
                  Found in src/Phan/Config/Initializer.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

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

                      public static function generateEntrySnippetForSetting(string $setting_name, $setting_value, array $additional_comment_lines): string
                      {
                          $source = self::generateCommentForSetting($setting_name);
                          foreach ($additional_comment_lines as $line) {
                              $source .= "    // $line\n";
                  Severity: Minor
                  Found in src/Phan/Config/Initializer.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

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

                      public static function determineTargetPHPVersion(array $composer_settings): array
                      {
                          $php_version_constraint = $composer_settings['require']['php'] ?? null;
                          if (!$php_version_constraint || !is_string($php_version_constraint)) {
                              return [null, ['TODO: Choose a target_php_version for this project, or leave as null and remove this comment']];
                  Severity: Minor
                  Found in src/Phan/Config/Initializer.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

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

                      public static function createPhanSettingsForComposerSettings(array $composer_settings, ?string $vendor_path, array $opts): InitializedSettings
                      {
                          $level = $opts['init-level'] ?? 3;
                          $level = self::LEVEL_MAP[\strtolower((string)$level)] ?? $level;
                          if (\filter_var($level, FILTER_VALIDATE_INT) === false) {
                  Severity: Minor
                  Found in src/Phan/Config/Initializer.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

                  The class Initializer has a coupling between objects value of 18. Consider to reduce the number of dependencies under 13.
                  Open

                  class Initializer
                  {
                      /**
                       * @param array{init-overwrite?:mixed,init-no-composer?:mixed,init-level?:(int|string)} $opts
                       * Returns
                  Severity: Minor
                  Found in src/Phan/Config/Initializer.php by phpmd

                  CouplingBetweenObjects

                  Since: 1.1.0

                  A class with too many dependencies has negative impacts on several quality aspects of a class. This includes quality criteria like stability, maintainability and understandability

                  Example

                  class Foo {
                      /**
                       * @var \foo\bar\X
                       */
                      private $x = null;
                  
                      /**
                       * @var \foo\bar\Y
                       */
                      private $y = null;
                  
                      /**
                       * @var \foo\bar\Z
                       */
                      private $z = null;
                  
                      public function setFoo(\Foo $foo) {}
                      public function setBar(\Bar $bar) {}
                      public function setBaz(\Baz $baz) {}
                  
                      /**
                       * @return \SplObjectStorage
                       * @throws \OutOfRangeException
                       * @throws \InvalidArgumentException
                       * @throws \ErrorException
                       */
                      public function process(\Iterator $it) {}
                  
                      // ...
                  }

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

                  There are no issues that match your filters.

                  Category
                  Status