Merge pull request #4999 from paulbalandan/space-after-comment-start-fixer

Author: MGatner

.no-header.php-cs-fixer.dist.php

@@ -14,6 +14,7 @@
 use Nexus\CsConfig\Factory;
 use PhpCsFixer\Finder;
 use Utils\PhpCsFixer\CodeIgniter4;
+use Utils\PhpCsFixer\Fixer\Comment\SpaceAfterCommentStartFixer;
 
 $finder = Finder::create()
     ->files()
@@ -26,8 +27,14 @@
 $overrides = [];
 
 $options = [
-    'cacheFile' => 'build/.no-header.php-cs-fixer.cache',
-    'finder'    => $finder,
+    'cacheFile'    => 'build/.no-header.php-cs-fixer.cache',
+    'finder'       => $finder,
+    'customFixers' => [
+        new SpaceAfterCommentStartFixer(),
+    ],
+    'customRules' => [
+        'CodeIgniter4/space_after_comment_start' => true,
+    ],
 ];
 
 return Factory::create(new CodeIgniter4(), $overrides, $options)->forProjects();

.php-cs-fixer.dist.php

@@ -14,6 +14,7 @@
 use Nexus\CsConfig\Factory;
 use PhpCsFixer\Finder;
 use Utils\PhpCsFixer\CodeIgniter4;
+use Utils\PhpCsFixer\Fixer\Comment\SpaceAfterCommentStartFixer;
 
 $finder = Finder::create()
     ->files()
@@ -34,8 +35,14 @@
 $overrides = [];
 
 $options = [
-    'cacheFile' => 'build/.php-cs-fixer.cache',
-    'finder'    => $finder,
+    'cacheFile'    => 'build/.php-cs-fixer.cache',
+    'finder'       => $finder,
+    'customFixers' => [
+        new SpaceAfterCommentStartFixer(),
+    ],
+    'customRules' => [
+        'CodeIgniter4/space_after_comment_start' => true,
+    ],
 ];
 
 return Factory::create(new CodeIgniter4(), $overrides, $options)->forLibrary(

system/BaseModel.php

@@ -1327,7 +1327,7 @@ public function validate($data): bool
             return true;
         }
 
-        //Validation requires array, so cast away.
+        // Validation requires array, so cast away.
         if (is_object($data)) {
             $data = (array) $data;
         }

system/Cache/Handlers/MemcachedHandler.php

@@ -220,7 +220,7 @@ public function decrement(string $key, int $offset = 1)
 
         $key = static::validateKey($key, $this->prefix);
 
-        //FIXME: third parameter isn't other handler actions.
+        // FIXME: third parameter isn't other handler actions.
         // @phpstan-ignore-next-line
         return $this->memcached->decrement($key, $offset, $offset, 60);
     }

system/Common.php

@@ -978,8 +978,8 @@ function single_service(string $name, ...$params)
 }
 
 if (! function_exists('slash_item')) {
-    //Unlike CI3, this function is placed here because
-    //it's not a config, or part of a config.
+    // Unlike CI3, this function is placed here because
+    // it's not a config, or part of a config.
     /**
      * Fetch a config file item with slash appended (if not empty)
      *

system/Database/BaseConnection.php

@@ -461,7 +461,7 @@ abstract public function reconnect();
      */
     public function getConnection(?string $alias = null)
     {
-        //@todo work with read/write connections
+        // @todo work with read/write connections
         return $this->connID;
     }
 

system/Debug/Exceptions.php

@@ -85,7 +85,7 @@ public function __construct(ExceptionsConfig $config, IncomingRequest $request,
      */
     public function initialize()
     {
-        //Set the Exception Handler
+        // Set the Exception Handler
         set_exception_handler([$this, 'exceptionHandler']);
 
         // Set the Error Handler

system/Entity/Entity.php

@@ -353,7 +353,7 @@ protected function castAs($value, string $attribute, string $method = 'get')
             $type = substr($type, 1);
         }
 
-        //In order not to create a separate handler for the
+        // In order not to create a separate handler for the
         // json-array type, we transform the required one.
         $type = $type === 'json-array' ? 'json[array]' : $type;
 
@@ -363,7 +363,7 @@ protected function castAs($value, string $attribute, string $method = 'get')
 
         $params = [];
 
-        //Attempt to retrieve additional parameters if specified
+        // Attempt to retrieve additional parameters if specified
         // type[param, param2,param3]
         if (preg_match('/^(.+)\[(.+)\]$/', $type, $matches)) {
             $type   = $matches[1];

system/HTTP/Files/UploadedFile.php

@@ -127,7 +127,7 @@ public function __construct(string $path, string $originalName, ?string $mimeTyp
     public function move(string $targetPath, ?string $name = null, bool $overwrite = false)
     {
         $targetPath = rtrim($targetPath, '/') . '/';
-        $targetPath = $this->setPath($targetPath); //set the target path
+        $targetPath = $this->setPath($targetPath); // set the target path
 
         if ($this->hasMoved) {
             throw HTTPException::forAlreadyMoved();
@@ -169,7 +169,7 @@ protected function setPath(string $path): string
     {
         if (! is_dir($path)) {
             mkdir($path, 0777, true);
-            //create the index.html file
+            // create the index.html file
             if (! is_file($path . 'index.html')) {
                 $file = fopen($path . 'index.html', 'x+b');
                 fclose($file);

system/Helpers/inflector_helper.php

@@ -27,7 +27,7 @@ function singular(string $string): string
             return $result;
         }
 
-        //Arranged in order.
+        // Arranged in order.
         $singularRules = [
             '/(matr)ices$/'                                                   => '\1ix',
             '/(vert|ind)ices$/'                                               => '\1ex',