InterNACHI/modular

View on GitHub

Showing 13 of 13 total issues

Similar blocks of code found in 2 locations. Consider refactoring.
Open

<?php

namespace InterNACHI\Modular\Support\PhpStorm;

use Illuminate\Support\Str;
Severity: Major
Found in src/Support/PhpStorm/WorkspaceWriter.php and 1 other location - About 7 hrs to fix
src/Support/PhpStorm/PhpFrameworkWriter.php on lines 1..34

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 230.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Similar blocks of code found in 2 locations. Consider refactoring.
Open

<?php

namespace InterNACHI\Modular\Support\PhpStorm;

use Illuminate\Support\Str;
Severity: Major
Found in src/Support/PhpStorm/PhpFrameworkWriter.php and 1 other location - About 7 hrs to fix
src/Support/PhpStorm/WorkspaceWriter.php on lines 1..34

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 230.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

File ModularServiceProvider.php has 308 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

namespace InterNACHI\Modular\Support;

use Closure;
Severity: Minor
Found in src/Support/ModularServiceProvider.php - About 3 hrs to fix

    ModularServiceProvider has 23 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class ModularServiceProvider extends ServiceProvider
    {
        /**
         * @var \InterNACHI\Modular\Support\ModuleRegistry
         */
    Severity: Minor
    Found in src/Support/ModularServiceProvider.php - About 2 hrs to fix

      Method updateCoreComposerConfig has 46 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          protected function updateCoreComposerConfig()
          {
              $this->title('Updating application composer.json file');
              
              // We're going to move into the Laravel base directory while
      Severity: Minor
      Found in src/Console/Commands/Make/MakeModule.php - About 1 hr to fix

        Method writeStubs has 31 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            protected function writeStubs()
            {
                $this->title('Creating initial module files');
                
                $tests_base = config('app-modules.tests_base', 'Tests\TestCase');
        Severity: Minor
        Found in src/Console/Commands/Make/MakeModule.php - About 1 hr to fix

          Method createClass has 27 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

                  protected function createClass($force = false, $inline = false)
                  {
                      if ($module = $this->module()) {
                          $name = Str::of($this->argument('name'))
                              ->split('/[.\/(\\\\)]+/')
          Severity: Minor
          Found in src/Console/Commands/Make/MakeLivewire.php - About 1 hr to fix

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

                public function write(): bool
                {
                    $modules_directory = config('app-modules.modules_directory', 'app-modules');
                    
                    $iml = $this->getNormalizedPluginConfig();
            Severity: Minor
            Found in src/Support/PhpStorm/ProjectImlWriter.php - About 1 hr to fix

              Function updateCoreComposerConfig has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
              Open

                  protected function updateCoreComposerConfig()
                  {
                      $this->title('Updating application composer.json file');
                      
                      // We're going to move into the Laravel base directory while
              Severity: Minor
              Found in src/Console/Commands/Make/MakeModule.php - About 55 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

              Similar blocks of code found in 3 locations. Consider refactoring.
              Open

                  protected function updatePhpStormPhpConfig(): void
                  {
                      $config_path = $this->getLaravel()->basePath('.idea/php.xml');
                      $writer = new PhpFrameworkWriter($config_path, $this->registry);
                      
              Severity: Minor
              Found in src/Console/Commands/ModulesSync.php and 2 other locations - About 30 mins to fix
              src/Console/Commands/ModulesSync.php on lines 90..103
              src/Console/Commands/ModulesSync.php on lines 120..133

              Duplicated Code

              Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

              Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

              When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

              Tuning

              This issue has a mass of 90.

              We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

              The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

              If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

              See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

              Refactorings

              Further Reading

              Similar blocks of code found in 3 locations. Consider refactoring.
              Open

                  protected function updatePhpStormLaravelPlugin(): void
                  {
                      $config_path = $this->getLaravel()->basePath('.idea/laravel-plugin.xml');
                      $writer = new LaravelConfigWriter($config_path, $this->registry);
                      
              Severity: Minor
              Found in src/Console/Commands/ModulesSync.php and 2 other locations - About 30 mins to fix
              src/Console/Commands/ModulesSync.php on lines 105..118
              src/Console/Commands/ModulesSync.php on lines 120..133

              Duplicated Code

              Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

              Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

              When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

              Tuning

              This issue has a mass of 90.

              We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

              The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

              If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

              See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

              Refactorings

              Further Reading

              Similar blocks of code found in 3 locations. Consider refactoring.
              Open

                  protected function updatePhpStormWorkspaceConfig(): void
                  {
                      $config_path = $this->getLaravel()->basePath('.idea/workspace.xml');
                      $writer = new WorkspaceWriter($config_path, $this->registry);
                      
              Severity: Minor
              Found in src/Console/Commands/ModulesSync.php and 2 other locations - About 30 mins to fix
              src/Console/Commands/ModulesSync.php on lines 90..103
              src/Console/Commands/ModulesSync.php on lines 105..118

              Duplicated Code

              Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

              Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

              When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

              Tuning

              This issue has a mass of 90.

              We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

              The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

              If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

              See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

              Refactorings

              Further Reading

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

                      protected function createClass($force = false, $inline = false)
                      {
                          if ($module = $this->module()) {
                              $name = Str::of($this->argument('name'))
                                  ->split('/[.\/(\\\\)]+/')
              Severity: Minor
              Found in src/Console/Commands/Make/MakeLivewire.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

              Severity
              Category
              Status
              Source
              Language