Merge pull request #6449 from kenjis/move-kint-to-require-dev

chore: move Kint to `require-dev`

Author: kenjis

admin/framework/composer.json

@@ -10,11 +10,11 @@
         "ext-intl": "*",
         "ext-json": "*",
         "ext-mbstring": "*",
-        "kint-php/kint": "^4.2",
         "laminas/laminas-escaper": "^2.9",
         "psr/log": "^1.1"
     },
     "require-dev": {
+        "kint-php/kint": "^4.2",
         "codeigniter/coding-standard": "^1.1",
         "fakerphp/faker": "^1.9",
         "friendsofphp/php-cs-fixer": "3.6.*",

composer.json

@@ -10,11 +10,11 @@
         "ext-intl": "*",
         "ext-json": "*",
         "ext-mbstring": "*",
-        "kint-php/kint": "^4.2",
         "laminas/laminas-escaper": "^2.9",
         "psr/log": "^1.1"
     },
     "require-dev": {
+        "kint-php/kint": "^4.2",
         "codeigniter/coding-standard": "^1.1",
         "fakerphp/faker": "^1.9",
         "friendsofphp/php-cs-fixer": "3.6.*",

system/CodeIgniter.php

@@ -183,10 +183,6 @@ public function initialize()
         date_default_timezone_set($this->config->appTimezone ?? 'UTC');
 
         $this->initializeKint();
-
-        if (! CI_DEBUG) {
-            Kint::$enabled_mode = false; // @codeCoverageIgnore
-        }
     }
 
     /**
@@ -223,6 +219,20 @@ protected function resolvePlatformExtensions()
      * Initializes Kint
      */
     protected function initializeKint()
+    {
+        if (CI_DEBUG) {
+            $this->autoloadKint();
+            $this->configureKint();
+        } elseif (class_exists(Kint::class)) {
+            // In case that Kint is already loaded via Composer.
+            Kint::$enabled_mode = false;
+            // @codeCoverageIgnore
+        }
+
+        helper('kint');
+    }
+
+    private function autoloadKint(): void
     {
         // If we have KINT_DIR it means it's already loaded via composer
         if (! defined('KINT_DIR')) {
@@ -242,7 +252,10 @@ protected function initializeKint()
 
             require_once SYSTEMPATH . 'ThirdParty/Kint/init.php';
         }
+    }
 
+    private function configureKint(): void
+    {
         /** @var \Config\Kint $config */
         $config = config(KintConfig::class);
 

system/Common.php

@@ -347,25 +347,6 @@ function db_connect($db = null, bool $getShared = true)
     }
 }
 
-if (! function_exists('dd')) {
-    /**
-     * Prints a Kint debug report and exits.
-     *
-     * @param array ...$vars
-     *
-     * @codeCoverageIgnore Can't be tested ... exits
-     */
-    function dd(...$vars)
-    {
-        // @codeCoverageIgnoreStart
-        Kint::$aliases[] = 'dd';
-        Kint::dump(...$vars);
-
-        exit;
-        // @codeCoverageIgnoreEnd
-    }
-}
-
 if (! function_exists('env')) {
     /**
      * Allows user to retrieve values from the environment
@@ -1109,17 +1090,6 @@ function timer(?string $name = null, ?callable $callable = null)
     }
 }
 
-if (! function_exists('trace')) {
-    /**
-     * Provides a backtrace to the current execution point, from Kint.
-     */
-    function trace()
-    {
-        Kint::$aliases[] = 'trace';
-        Kint::trace();
-    }
-}
-
 if (! function_exists('view')) {
     /**
      * Grabs the current RendererInterface-compatible class

system/ComposerScripts.php

@@ -69,8 +69,14 @@ public static function postUpdate()
     {
         self::recursiveDelete(self::$path);
 
-        foreach (self::$dependencies as $dependency) {
+        foreach (self::$dependencies as $key => $dependency) {
+            // Kint may be removed.
+            if (! is_dir($dependency['from']) && strpos($key, 'kint') === 0) {
+                continue;
+            }
+
             self::recursiveMirror($dependency['from'], $dependency['to']);
+
             if (isset($dependency['license'])) {
                 $license = basename($dependency['license']);
                 copy($dependency['license'], $dependency['to'] . '/' . $license);

system/Helpers/kint_helper.php

@@ -0,0 +1,66 @@
+<?php
+
+/**
+ * This file is part of CodeIgniter 4 framework.
+ *
+ * (c) CodeIgniter Foundation <[email protected]>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+// This helper is autoloaded by CodeIgniter.
+
+if (! function_exists('dd')) {
+    if (class_exists(Kint::class)) {
+        /**
+         * Prints a Kint debug report and exits.
+         *
+         * @param array ...$vars
+         *
+         * @codeCoverageIgnore Can't be tested ... exits
+         */
+        function dd(...$vars)
+        {
+            // @codeCoverageIgnoreStart
+            Kint::$aliases[] = 'dd';
+            Kint::dump(...$vars);
+
+            exit;
+            // @codeCoverageIgnoreEnd
+        }
+    } else {
+        // In case that Kint is not loaded.
+        function dd(...$vars)
+        {
+            return 0;
+        }
+    }
+}
+
+if (! function_exists('d') && ! class_exists(Kint::class)) {
+    // In case that Kint is not loaded.
+    function d(...$vars)
+    {
+        return 0;
+    }
+}
+
+if (! function_exists('trace')) {
+    if (class_exists(Kint::class)) {
+        /**
+         * Provides a backtrace to the current execution point, from Kint.
+         */
+        function trace()
+        {
+            Kint::$aliases[] = 'trace';
+            Kint::trace();
+        }
+    } else {
+        // In case that Kint is not loaded.
+        function trace()
+        {
+            return 0;
+        }
+    }
+}