Merge pull request #6484 from paulbalandan/single_line_comment_spacing

Enable `single_line_comment_spacing`
codeigniter4 · Sep 4, 2022 · a5154bf · a5154bf
2 parents 780f2e0 + 5a182de
commit a5154bf
Show file tree

Hide file tree

Showing 26 changed files with 155 additions and 153 deletions.
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -72,7 +72,8 @@
             ['var', 'phpstan-var', 'psalm-var'],
         ],
     ],
-    'statement_indentation' => true,
+    'single_line_comment_spacing' => true,
+    'statement_indentation'       => true,
     // >>>>>>>>>>>>>>>>>>>>>>>>>
 ];
 

diff --git a/.php-cs-fixer.no-header.php b/.php-cs-fixer.no-header.php
@@ -64,7 +64,8 @@
             ['var', 'phpstan-var', 'psalm-var'],
         ],
     ],
-    'statement_indentation' => true,
+    'single_line_comment_spacing' => true,
+    'statement_indentation'       => true,
     // >>>>>>>>>>>>>>>>>>>>>>>>>
 ];
 

diff --git a/.php-cs-fixer.user-guide.php b/.php-cs-fixer.user-guide.php
@@ -66,7 +66,8 @@
             ['var', 'phpstan-var', 'psalm-var'],
         ],
     ],
-    'statement_indentation' => true,
+    'single_line_comment_spacing' => true,
+    'statement_indentation'       => true,
     // >>>>>>>>>>>>>>>>>>>>>>>>>
 ];
 

diff --git a/app/Config/ContentSecurityPolicy.php b/app/Config/ContentSecurityPolicy.php
@@ -15,9 +15,9 @@
  */
 class ContentSecurityPolicy extends BaseConfig
 {
-    //-------------------------------------------------------------------------
+    // -------------------------------------------------------------------------
     // Broadbrush CSP management
-    //-------------------------------------------------------------------------
+    // -------------------------------------------------------------------------
 
     /**
      * Default CSP report context
@@ -43,10 +43,10 @@ class ContentSecurityPolicy extends BaseConfig
      */
     public $upgradeInsecureRequests = false;
 
-    //-------------------------------------------------------------------------
+    // -------------------------------------------------------------------------
     // Sources allowed
     // Note: once you set a policy to 'none', it cannot be further restricted
-    //-------------------------------------------------------------------------
+    // -------------------------------------------------------------------------
 
     /**
      * Will default to self if not overridden

diff --git a/app/Config/Routes.php b/app/Config/Routes.php
@@ -25,7 +25,7 @@
 // where controller filters or CSRF protection are bypassed.
 // If you don't want to define all routes, please use the Auto Routing (Improved).
 // Set `$autoRoutesImproved` to true in `app/Config/Feature.php` and set the following to true.
-//$routes->setAutoRoute(false);
+// $routes->setAutoRoute(false);
 
 /*
  * --------------------------------------------------------------------

diff --git a/app/Config/Validation.php b/app/Config/Validation.php
@@ -10,9 +10,9 @@
 
 class Validation extends BaseConfig
 {
-    //--------------------------------------------------------------------
+    // --------------------------------------------------------------------
     // Setup
-    //--------------------------------------------------------------------
+    // --------------------------------------------------------------------
 
     /**
      * Stores the classes that contain the
@@ -38,7 +38,7 @@ class Validation extends BaseConfig
         'single' => 'CodeIgniter\Validation\Views\single',
     ];
 
-    //--------------------------------------------------------------------
+    // --------------------------------------------------------------------
     // Rules
-    //--------------------------------------------------------------------
+    // --------------------------------------------------------------------
 }
diff --git a/system/API/ResponseTrait.php b/system/API/ResponseTrait.php
@@ -136,9 +136,9 @@ protected function fail($messages, int $status = 400, ?string $code = null, stri
         return $this->respond($response, $status, $customMessage);
     }
 
-    //--------------------------------------------------------------------
+    // --------------------------------------------------------------------
     // Response Helpers
-    //--------------------------------------------------------------------
+    // --------------------------------------------------------------------
 
     /**
      * Used after successfully creating a new resource.
@@ -290,9 +290,9 @@ protected function failServerError(string $description = 'Internal Server Error'
         return $this->fail($description, $this->codes['server_error'], $code, $message);
     }
 
-    //--------------------------------------------------------------------
+    // --------------------------------------------------------------------
     // Utility Methods
-    //--------------------------------------------------------------------
+    // --------------------------------------------------------------------
 
     /**
      * Handles formatting a response. Currently makes some heavy assumptions

diff --git a/system/CLI/CLI.php b/system/CLI/CLI.php
@@ -756,9 +756,9 @@ public static function wrap(?string $string = null, int $max = 0, int $padLeft =
         return $lines;
     }
 
-    //--------------------------------------------------------------------
+    // --------------------------------------------------------------------
     // Command-Line 'URI' support
-    //--------------------------------------------------------------------
+    // --------------------------------------------------------------------
 
     /**
      * Parses the command line it was called from and collects all

diff --git a/system/Cookie/Cookie.php b/system/Cookie/Cookie.php
@@ -152,9 +152,9 @@ public static function setDefaults($config = [])
         return $oldDefaults;
     }
 
-    //=========================================================================
+    // =========================================================================
     // CONSTRUCTORS
-    //=========================================================================
+    // =========================================================================
 
     /**
      * Create a new Cookie instance from a `Set-Cookie` header.
@@ -238,9 +238,9 @@ final public function __construct(string $name, string $value = '', array $optio
         $this->raw      = $raw;
     }
 
-    //=========================================================================
+    // =========================================================================
     // GETTERS
-    //=========================================================================
+    // =========================================================================
 
     /**
      * {@inheritDoc}
@@ -391,9 +391,9 @@ public function getOptions(): array
         ];
     }
 
-    //=========================================================================
+    // =========================================================================
     // CLONING
-    //=========================================================================
+    // =========================================================================
 
     /**
      * {@inheritDoc}
@@ -556,9 +556,9 @@ public function withRaw(bool $raw = true)
         return $cookie;
     }
 
-    //=========================================================================
+    // =========================================================================
     // ARRAY ACCESS FOR BC
-    //=========================================================================
+    // =========================================================================
 
     /**
      * Whether an offset exists.
@@ -614,9 +614,9 @@ public function offsetUnset($offset): void
         throw new LogicException(sprintf('Cannot unset values of properties of %s as it is immutable.', static::class));
     }
 
-    //=========================================================================
+    // =========================================================================
     // CONVERTERS
-    //=========================================================================
+    // =========================================================================
 
     /**
      * {@inheritDoc}
@@ -716,9 +716,9 @@ protected static function convertExpiresTimestamp($expires = 0): int
         return $expires > 0 ? (int) $expires : 0;
     }
 
-    //=========================================================================
+    // =========================================================================
     // VALIDATION
-    //=========================================================================
+    // =========================================================================
 
     /**
      * Validates the cookie name per RFC 2616.

diff --git a/system/Database/BaseConnection.php b/system/Database/BaseConnection.php
@@ -1352,9 +1352,9 @@ protected function getDriverFunctionPrefix(): string
         return strtolower($this->DBDriver) . '_';
     }
 
-    //--------------------------------------------------------------------
+    // --------------------------------------------------------------------
     // META Methods
-    //--------------------------------------------------------------------
+    // --------------------------------------------------------------------
 
     /**
      * Returns an array of table names

diff --git a/system/Debug/Exceptions.php b/system/Debug/Exceptions.php
@@ -329,9 +329,9 @@ protected function determineCodes(Throwable $exception): array
         return [$statusCode, $exitStatus];
     }
 
-    //--------------------------------------------------------------------
+    // --------------------------------------------------------------------
     // Display Methods
-    //--------------------------------------------------------------------
+    // --------------------------------------------------------------------
 
     /**
      * This makes nicer looking paths for the error output.

diff --git a/system/Files/FileCollection.php b/system/Files/FileCollection.php
@@ -33,9 +33,9 @@ class FileCollection implements Countable, IteratorAggregate
      */
     protected $files = [];
 
-    //--------------------------------------------------------------------
+    // --------------------------------------------------------------------
     // Support Methods
-    //--------------------------------------------------------------------
+    // --------------------------------------------------------------------
 
     /**
      * Resolves a full path and verifies it is an actual directory.
@@ -106,9 +106,9 @@ final protected static function matchFiles(array $files, string $pattern): array
         return array_filter($files, static fn ($value) => (bool) preg_match($pattern, basename($value)));
     }
 
-    //--------------------------------------------------------------------
+    // --------------------------------------------------------------------
     // Class Core
-    //--------------------------------------------------------------------
+    // --------------------------------------------------------------------
 
     /**
      * Loads the Filesystem helper and adds any initial files.
@@ -189,9 +189,9 @@ public function add($paths, bool $recursive = true)
         return $this;
     }
 
-    //--------------------------------------------------------------------
+    // --------------------------------------------------------------------
     // File Handling
-    //--------------------------------------------------------------------
+    // --------------------------------------------------------------------
 
     /**
      * Verifies and adds files to the list.
@@ -245,9 +245,9 @@ public function removeFile(string $file)
         return $this->removeFiles([$file]);
     }
 
-    //--------------------------------------------------------------------
+    // --------------------------------------------------------------------
     // Directory Handling
-    //--------------------------------------------------------------------
+    // --------------------------------------------------------------------
 
     /**
      * Verifies and adds files from each
@@ -287,9 +287,9 @@ public function addDirectory(string $directory, bool $recursive = false)
         return $this;
     }
 
-    //--------------------------------------------------------------------
+    // --------------------------------------------------------------------
     // Filtering
-    //--------------------------------------------------------------------
+    // --------------------------------------------------------------------
 
     /**
      * Removes any files from the list that match the supplied pattern
@@ -335,9 +335,9 @@ public function retainPattern(string $pattern, ?string $scope = null)
         return $this->removeFiles(array_diff($files, self::matchFiles($files, $pattern)));
     }
 
-    //--------------------------------------------------------------------
+    // --------------------------------------------------------------------
     // Interface Methods
-    //--------------------------------------------------------------------
+    // --------------------------------------------------------------------
 
     /**
      * Returns the current number of files in the collection.

diff --git a/system/Filters/Filters.php b/system/Filters/Filters.php
@@ -382,9 +382,9 @@ public function getArguments(?string $key = null)
         return $key === null ? $this->arguments : $this->arguments[$key];
     }
 
-    //--------------------------------------------------------------------
+    // --------------------------------------------------------------------
     // Processors
-    //--------------------------------------------------------------------
+    // --------------------------------------------------------------------
 
     /**
      * Add any applicable (not excluded) global filter settings to the mix.

diff --git a/system/HTTP/MessageTrait.php b/system/HTTP/MessageTrait.php
@@ -38,9 +38,9 @@ trait MessageTrait
      */
     protected $headerMap = [];
 
-    //--------------------------------------------------------------------
+    // --------------------------------------------------------------------
     // Body
-    //--------------------------------------------------------------------
+    // --------------------------------------------------------------------
 
     /**
      * Sets the body of the current message.
@@ -70,9 +70,9 @@ public function appendBody($data): self
         return $this;
     }
 
-    //--------------------------------------------------------------------
+    // --------------------------------------------------------------------
     // Headers
-    //--------------------------------------------------------------------
+    // --------------------------------------------------------------------
 
     /**
      * Populates the $headers array with any headers the server knows about.

diff --git a/system/HTTP/Negotiate.php b/system/HTTP/Negotiate.php
@@ -122,9 +122,9 @@ public function language(array $supported): string
         return $this->getBestMatch($supported, $this->request->getHeaderLine('accept-language'), false, false, true);
     }
 
-    //--------------------------------------------------------------------
+    // --------------------------------------------------------------------
     // Utility Methods
-    //--------------------------------------------------------------------
+    // --------------------------------------------------------------------
 
     /**
      * Does the grunt work of comparing any of the app-supported values