Add component configurations to Sprig variable

CHANGELOG.md

@@ -4,9 +4,8 @@
 
 ### Added
 
-- Added the logging of component configurations to the browser console when `devMode` is enabled.
+- Added the component configurations to a `Sprig` variable in the browser console when `devMode` is enabled.
 - Added the `sprig.registerJs(js)` function.
-- Added the `sprig.consoleLog(value)` function.
 
 ### Changed
 

src/base/Component.php

@@ -248,18 +248,4 @@ public static function registerJs(string $js): void
         $html = Html::tag('div', $content, ['s-swap-oob' => 'beforeend:body']);
         Craft::$app->getView()->registerHtml($html);
     }
-
-    /**
-     * Logs a value to the console.
-     *
-     * @since 2.10.0
-     */
-    public static function consoleLog(mixed $value, bool $devModeOnly = true): void
-    {
-        if ($devModeOnly && Craft::$app->getConfig()->getGeneral()->devMode === false) {
-            return;
-        }
-
-        self::registerJs('console.log(' . Json::encode($value) . ')');
-    }
 }

src/controllers/ComponentsController.php

@@ -13,6 +13,7 @@
 use craft\web\Controller;
 use craft\web\UrlManager;
 use putyourlightson\sprig\base\Component;
+use putyourlightson\sprig\helpers\Console;
 use putyourlightson\sprig\Sprig;
 use yii\base\Event;
 use yii\web\ForbiddenHttpException;
@@ -69,7 +70,7 @@ public function actionRender(): Response
             $content = Craft::$app->getView()->renderTemplate($config->template, $variables);
         }
 
-        Component::consoleLog($config->getAttributes());
+        Console::addComponent($config);
 
         // Remove flashes after rendering, so they don’t appear on subsequent requests.
         Craft::$app->getSession()->removeAllFlashes();

src/helpers/Console.php

@@ -0,0 +1,51 @@
+<?php
+/**
+ * @copyright Copyright (c) PutYourLightsOn
+ */
+
+namespace putyourlightson\sprig\helpers;
+
+use Craft;
+use craft\helpers\Json;
+use putyourlightson\sprig\base\Component;
+use putyourlightson\sprig\models\ConfigModel;
+
+/**
+ * Manages the Sprig object in the console.
+ *
+ * @since 2.10.0
+ */
+class Console
+{
+    private static bool $initialized = false;
+
+    /**
+     * Initialises the Sprig object in the console.
+     */
+    public static function init(): void
+    {
+        if (self::$initialized || Component::getIsRequest()) {
+            return;
+        }
+
+        self::$initialized = true;
+
+        Component::registerJs('Sprig = {components: []}');
+    }
+
+    /**
+     * Adds a component to the Sprig object in the console.
+     */
+    public static function addComponent(ConfigModel $config): void
+    {
+        if (Craft::$app->getConfig()->getGeneral()->devMode === false) {
+            return;
+        }
+
+        self::init();
+
+        $value = Json::encode($config->getAttributes());
+
+        Component::registerJs('Sprig.components.push(' . $value . ')');
+    }
+}

src/services/ComponentsService.php

@@ -19,6 +19,7 @@
 use putyourlightson\sprig\base\Component;
 use putyourlightson\sprig\errors\FriendlyInvalidVariableException;
 use putyourlightson\sprig\events\ComponentEvent;
+use putyourlightson\sprig\helpers\Console;
 use putyourlightson\sprig\helpers\Html;
 use putyourlightson\sprig\models\ConfigModel;
 use putyourlightson\sprig\plugin\components\SprigPlayground;
@@ -250,7 +251,7 @@ public function create(string $value, array $variables = [], array $attributes =
         $this->validateVariables($variables);
         $config->variables = $variables;
 
-        Component::consoleLog($config->getAttributes());
+        Console::addComponent($config);
 
         // Add token to values if this is a preview request.
         // https://github.com/putyourlightson/craft-sprig/issues/162

src/variables/SprigVariable.php

@@ -303,16 +303,6 @@ public function registerJs(string $js): void
         Component::registerJs($js);
     }
 
-    /**
-     * Logs a value to the console.
-     *
-     * @since 2.10.0
-     */
-    public static function consoleLog(mixed $value, bool $devModeOnly = true): void
-    {
-        Component::consoleLog($value, $devModeOnly);
-    }
-
     /**
      * Returns a new component.
      */