@speedkit/cli 2.74.0 → 2.75.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [2.75.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.74.0...v2.75.0) (2025-01-15)
+
+
+### Features
+
+* **customer-config:** optimise wizard + add scoped deployments option ([23f379e](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/23f379ef48b2a831e26d958e1924894bb60007f6))
+
 # [2.74.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.73.1...v2.74.0) (2025-01-09)
 
 

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @speedkit/cli
 $ sk COMMAND
 running command...
 $ sk (--version)
-@speedkit/cli/2.74.0 linux-x64 node-v20.18.1
+@speedkit/cli/2.75.0 linux-x64 node-v20.18.1
 $ sk --help [COMMAND]
 USAGE
   $ sk COMMAND

package/dist/services/customer-config/customer-config-service-model.d.ts

@@ -23,6 +23,7 @@ export interface CustomerConfigSettings {
     appName?: string;
     production?: EnvironmentConfig;
     staging?: EnvironmentConfig;
+    activateScopedDeployments?: boolean;
     subRouteScope?: string;
     includeServiceWorker?: string;
     activateImageOptimisation?: boolean;

package/dist/services/customer-config/customer-config-service.js

@@ -118,10 +118,10 @@ class CustomerConfigService {
         this.cli.spacer();
     }
     async getEnvironmentConfig(environmentType, defaultHost) {
-        const host = await this.cli.prompt(`Enter ${environmentType.toUpperCase()} Host (without https://):`, {
+        const host = await this.cli.prompt(`[${environmentType.toUpperCase()}] Enter ${environmentType.toUpperCase()} host (without https://):`, {
             defaultAnswer: defaultHost,
         });
-        const forceInstall = !(await this.cli.confirm(`Is the install.js already present on ${environmentType.toUpperCase()}?`, false));
+        const forceInstall = !(await this.cli.confirm(`[${environmentType.toUpperCase()}] Is the install.js already present on ${environmentType.toUpperCase()}?`, false));
         return {
             host,
             forceInstall,
@@ -136,12 +136,12 @@ class CustomerConfigService {
         return true;
     }
     async getConfigSettings() {
-        let { production, staging, subRouteScope, includeServiceWorker, activateImageOptimisation, removeLazyLoading, addPreRendering, supportShadowDomInPreRendering, shadowDomCustomElementPrefix, activateRumTracking, useGATracking, useScrapingBee, withGoogleOptimize, activateCfRocketLoaderWorkaround, hasSoftNavigations, isShopify, isShopware, isSalesforce, isPlentymarkets, shopifyId, } = {};
-        this.appName = await this.cli.prompt(`Enter SK App Name:`, {
+        let { production, staging, activateScopedDeployments, subRouteScope, includeServiceWorker, activateImageOptimisation, removeLazyLoading, addPreRendering, supportShadowDomInPreRendering, shadowDomCustomElementPrefix, activateRumTracking, useGATracking, useScrapingBee, withGoogleOptimize, activateCfRocketLoaderWorkaround, hasSoftNavigations, isShopify, isShopware, isSalesforce, isPlentymarkets, shopifyId, } = {};
+        this.appName = await this.cli.prompt(`[App Name] Enter desired SK app name:`, {
             validator: (input) => /^[\da-z]+(?:-[\da-z]+)*$/.test(input) ? "" : "No valid kebab-case",
             defaultAnswer: this.appName,
         });
-        const selectedShopSystem = await this.cli.select("Which Shop System is in use?", Object.values(customer_config_service_model_1.ShopSystem).map((option) => ({
+        const selectedShopSystem = await this.cli.select("[Shop System] Which shop system is in use?", Object.values(customer_config_service_model_1.ShopSystem).map((option) => ({
             name: option,
             value: option,
         })));
@@ -162,49 +162,55 @@ class CustomerConfigService {
                 isPlentymarkets = true;
             }
         }
-        production = await this.getEnvironmentConfig(customer_config_service_model_1.EnvironmentType.PRODUCTION, `www.${this.appName}.de`);
         if (isShopify) {
-            shopifyId = await this.cli.prompt(`Enter Shopify ID:`, {
+            shopifyId = await this.cli.prompt(`[Shop System] Enter the shop's Shopify ID:`, {
                 defaultAnswer: this.appName,
             });
         }
-        else {
-            const withStaging = await this.cli.confirm(`Add Config for ${customer_config_service_model_1.EnvironmentType.STAGING.toUpperCase()} Environment?`, false);
+        production = await this.getEnvironmentConfig(customer_config_service_model_1.EnvironmentType.PRODUCTION, `www.${this.appName}.de`);
+        if (!isShopify) {
+            const withStaging = await this.cli.confirm(`[${customer_config_service_model_1.EnvironmentType.STAGING.toUpperCase()}] Should a ${customer_config_service_model_1.EnvironmentType.STAGING.toUpperCase()} config also be added?`, false);
             if (withStaging) {
-                staging = await this.getEnvironmentConfig(customer_config_service_model_1.EnvironmentType.STAGING, production.host.replace("www", "stg"));
+                staging = await this.getEnvironmentConfig(customer_config_service_model_1.EnvironmentType.STAGING, production.host.replace("www", "staging"));
             }
         }
-        if (await this.cli.confirm("Should SK only be active on specific sub-routes? (e.g. /de-de)", false)) {
-            subRouteScope = await this.cli.prompt("Enter one exemplary sub-route to scope to (without leading/trailing slashes):", { defaultAnswer: "de-de" });
+        activateScopedDeployments = await this.cli.confirm("[Scoping] Is the shop using (locale-based) sub-routes, like e.g. /de-de, on the basis of which scoped deployments should to be activated to prevent local-based changes from triggering a global deployment job?", false);
+        if (activateScopedDeployments &&
+            (await this.cli.confirm("[Scoping] Should SK only be active on specific sub-routes? (e.g. /de-de)", false))) {
+            subRouteScope = await this.cli.prompt("[Scoping] Enter one exemplary sub-route to scope SK to (without leading/trailing slashes):", { defaultAnswer: "de-de" });
         }
-        if (await this.cli.confirm("Is there a Service Worker which needs to be included?", false)) {
-            includeServiceWorker = await this.cli.prompt("Enter path of Service Worker to be included:", { defaultAnswer: "/sw.js" });
+        if (await this.cli.confirm("[Service Worker] Is there a Service Worker which needs to be included?", false)) {
+            includeServiceWorker = await this.cli.prompt("[Service Worker] Enter path of Service Worker to be included:", { defaultAnswer: "/sw.js" });
         }
-        activateImageOptimisation = await this.cli.confirm("Activate Image Optimisation?", false);
-        removeLazyLoading = await this.cli.confirm("Remove Lazy-Loading?");
-        if (await this.cli.confirm("Add Pre-Rendering? This requires a set-up Lambda function to work. Also requires usage of the DOM-based DocumentHandler.", false)) {
+        activateImageOptimisation = await this.cli.confirm("[IO] Should image optimisation be activated?", false);
+        removeLazyLoading = await this.cli.confirm("[Lazy-Loading] Does the shop require us to resolve lazy-loaded content?");
+        if (await this.cli.confirm("[Pre-Rendering] Add pre-rendering? This requires a set-up Lambda function to work. Also requires usage of the DOM-based DocumentHandler.", false)) {
             addPreRendering = true;
-            if (await this.cli.confirm("Does the customer utilize Shadow DOMs? If so additional handling for this will be added.", false)) {
+            if (await this.cli.confirm("[Pre-Rendering] Does the customer utilize Shadow DOMs? If so additional handling for this will be added.", false)) {
                 supportShadowDomInPreRendering = true;
-                shadowDomCustomElementPrefix = await this.cli.prompt("Please specify the prefix of the custom elements used (e.g. o2 uses tef-): ", { defaultAnswer: "custom-" });
+                shadowDomCustomElementPrefix = await this.cli.prompt("[Pre-Rendering] Please specify the prefix of the custom elements used (e.g. o2 uses tef-): ", { defaultAnswer: "custom-" });
             }
         }
-        useScrapingBee = await this.cli.confirm("Do customer responses differ geo-location-based (ScrapingBee will be needed to fetch documents)?", false);
-        activateRumTracking = await this.cli.confirm("Activate RUM Tracking?");
-        if (activateRumTracking) {
-            if (!isShopify) {
-                useGATracking = await this.cli.confirm("Add Tracking based on Google Analytics' DataLayer?");
-            }
-            hasSoftNavigations = await this.cli.confirm("Add Tracking for Soft Navigations?", false);
+        useScrapingBee = await this.cli.confirm("[ScrapingBee] Do customer responses differ geo-location-based which would require ScrapingBee API to fetch documents?", false);
+        activateRumTracking = true;
+        // activateRumTracking = await this.cli.confirm(
+        //   "[Tracking] Activate RUM Tracking?",
+        // );
+        // if (activateRumTracking) {
+        if (!isShopify) {
+            useGATracking = await this.cli.confirm("[Tracking] Add tracking based on Google Analytics' DataLayer?");
         }
-        withGoogleOptimize = await this.cli.confirm("Is Google Optimize being used?", false);
+        hasSoftNavigations = await this.cli.confirm("[Tracking] Add tracking for Soft Navigations?", false);
+        // }
+        withGoogleOptimize = await this.cli.confirm("[Services] Is Google Optimize used?", false);
         activateCfRocketLoaderWorkaround = isShopify
             ? true
-            : await this.cli.confirm("Activate Workaround for Cloudflare's Rocket Loader?", false);
+            : await this.cli.confirm("[Services] Is Cloudflare's Rocket Loader used, for which we would need to activate a workaround?", false);
         return {
             appName: this.appName,
             production,
             staging,
+            activateScopedDeployments,
             subRouteScope,
             includeServiceWorker,
             activateImageOptimisation,
@@ -238,7 +244,7 @@ class CustomerConfigService {
     async generateConfig() {
         this.cli.write("\nLet's generate a config...\n");
         const configSettings = await this.getConfigSettings();
-        const addDowntimeDetection = await this.cli.confirm("Add Downtime Detection?", false);
+        const addDowntimeDetection = await this.cli.confirm("[Downtime Detection] Add Downtime Detection?", false);
         if (addDowntimeDetection) {
             this.templates.push("downtimeDetection.js.hbs");
         }

package/dist/services/customer-config/templates/config_documentHandler.js.hbs

@@ -121,7 +121,13 @@ const config = {
 {{else}}
   delayScriptPath: "/speed-kit-dom-ready.js",
 {{/if}}
+{{#if activateScopedDeployments}}
+  executeDeploymentDetection: {
+    scope: true,
+  },
+{{else}}
   executeDeploymentDetection: true,
+{{/if}}
   {{#unless addPreRendering}}
     {{#if removeLazyLoading}}
       lazyLoadList,

package/oclif.manifest.json

@@ -712,5 +712,5 @@
       ]
     }
   },
-  "version": "2.74.0"
+  "version": "2.75.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@speedkit/cli",
   "description": "Speed Kit CLI",
-  "version": "2.74.0",
+  "version": "2.75.0",
   "author": {
     "name": "Baqend.com",
     "email": "info@baqend.com"