DarkaOnLine/SwaggerLume

View on GitHub

Showing 6 of 34 total issues

Function publishDirectory has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
Open

    public function publishDirectory($source, $destination)
    {
        if (! is_dir($source)) {
            $this->command->error('Bad source path');
        } else {
Severity: Minor
Found in src/Console/Helpers/Publisher.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 generateDocs has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
Open

    public static function generateDocs()
    {
        $appDir = config('swagger-lume.paths.annotations');
        $docDir = config('swagger-lume.paths.docs');
        if (! File::exists($docDir) || is_writable($docDir)) {
Severity: Minor
Found in src/Generator.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 docs has 38 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function docs()
    {
        $filePath = sprintf(
            '%s/%s',
            config('swagger-lume.paths.docs'),
Severity: Minor
Found in src/Http/Controllers/SwaggerLumeController.php - About 1 hr to fix

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

        public static function generateDocs()
        {
            $appDir = config('swagger-lume.paths.annotations');
            $docDir = config('swagger-lume.paths.docs');
            if (! File::exists($docDir) || is_writable($docDir)) {
    Severity: Minor
    Found in src/Generator.php - About 1 hr to fix

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

          public function publishFile($source, $destinationPath, $fileName)
          {
              if (! is_dir($destinationPath)) {
                  if (! mkdir($destinationPath, 0755, true)) {
                      $this->command->error('Cant crate directory: '.$destinationPath);
      Severity: Minor
      Found in src/Console/Helpers/Publisher.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 docs has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
      Open

          public function docs()
          {
              $filePath = sprintf(
                  '%s/%s',
                  config('swagger-lume.paths.docs'),
      Severity: Minor
      Found in src/Http/Controllers/SwaggerLumeController.php - About 35 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