@speedkit/cli 2.8.0 → 2.10.0

package/CHANGELOG.md

@@ -0,0 +1,79 @@
+# [2.10.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.9.0...v2.10.0) (2024-03-15)
+
+
+### Features
+
+* update dependencies ([30f8889](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/30f88894848e224546747d1aeed566ea15607bb9))
+
+# [2.9.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.8.0...v2.9.0) (2024-03-15)
+
+
+### Features
+
+* adjust eslint configuration ([5d7a0b9](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/5d7a0b98615612a32f87208dbf7d5017996ab7ca))
+
+# [2.8.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.7.0...v2.8.0) (2024-03-08)
+
+
+### Features
+
+* **onboarding:** load serverConfig for documentHandlerRequests ([4953244](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/49532441ab1e927373be886d926e56231d04a6ae))
+
+# [2.7.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.6.0...v2.7.0) (2024-03-06)
+
+
+### Features
+
+* optimise package json ([6b1b8b2](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/6b1b8b29a04e1ff08ff30e4d18c73168e8ca7aee))
+
+# [2.6.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.5.0...v2.6.0) (2024-03-05)
+
+
+### Features
+
+* add updateNotificationPlugin ([b81b4c0](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/b81b4c0575b81b52b541c4a30b43d6c9deaa17b5))
+* **origins:** merge  main ([4c43612](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/4c43612d403453809b10a2f3f7bd284364591373))
+* **updateNotification:** add missing config ([bb33eda](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/bb33eda03ab129320e9c93960469bbb35cce09dc))
+* **versionNotify:** update packageLockJson ([520b212](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/520b212543b78ea2d34e8eeafb44319e9785357a))
+
+# [2.5.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.4.1...v2.5.0) (2024-03-05)
+
+
+### Features
+
+* **onboarding:** allow vmDocumentHandler to requestAllModules from outer NodeJs ([82dbeb1](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/82dbeb1a261e4a3b72f63f3a3576ee12f68c3912))
+
+## [2.4.1](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.4.0...v2.4.1) (2024-03-01)
+
+
+### Bug Fixes
+
+* **customer-config:** update config customer template ([a69a47d](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/a69a47de326b813650f5364bcd4cdfa1659b9563))
+
+# [2.4.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.3.0...v2.4.0) (2024-03-01)
+
+
+### Features
+
+* update dependencies ([ee809a7](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/ee809a7beb2077d6db5c150126964facf307e9a3))
+
+# [2.3.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.2.0...v2.3.0) (2024-03-01)
+
+
+### Features
+
+* **customer-config:** disable all sites by default ([b2c9e9d](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/b2c9e9dcc20c98619691986191cff75843237f9b))
+* **deploy:** merge main ([8f8aac2](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/8f8aac2119b9d02a25bf32a073f4a283d99d7f5a))
+* **diff:** add diffExecutionTemplate ([04a8aa6](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/04a8aa6d4224ce142264a03905090c58ee59edf7))
+* **documentHandler:** fix fileCreation on mac ([424c116](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/424c116887c2190d672b66d9e99b5d17cdc6eae6))
+* **onboarding:** add support for predictive-preloading ([4ac6a21](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/4ac6a21f6603426e89628f5256bda9f0d7855d87))
+* **pull:** add check for changed files ([3251875](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/3251875b36e717d63b0a60fc43a4dcdf9a5febd0))
+* **pull:** add delete and create Actions ([306e46d](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/306e46dcacdc52d9a36fd41359a276b7c58abfb7))
+* **pull:** add delete- and createFileActions ([7e0e66e](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/7e0e66e498e117ed13e720e625f41adbb7b07e51))
+* **pull:** add testingFramework ([35cc8ec](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/35cc8eca3f99c90174a3766e31e5d19730af912f))
+* **pull:** merge main ([f73a729](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/f73a7298192b111b6245ac099b51ee57fa4a5c48))
+* **pull:** remove tryCatch from pullCommand ([90b873c](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/90b873c2e2205b05d3670de8af7e842cef8ad395))
+* **pullService:** add tests ([e07e7a9](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/e07e7a900d53e75fde1948666cd9a27926d5f302))
+* **sync:** pull command ([8b2b43a](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/8b2b43a299f9b7ccb11779dacdabf1329cd6274f))
+* **userConfig:** add configFile for cli ([b6e052e](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/b6e052e21a25b7b6800156977ed58b6ee5ecf93b))
+* **userConfig:** update readme.md ([55a1f5b](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/55a1f5bb3ec816a2a38b429cd19fb8a1bc74c21d))

package/README.md

@@ -74,7 +74,7 @@ $ npm install -g @speedkit/cli
 $ sk COMMAND
 running command...
 $ sk (--version)
-@speedkit/cli/2.8.0 linux-x64 node-v20.11.1
+@speedkit/cli/2.10.0 linux-x64 node-v20.11.1
 $ sk --help [COMMAND]
 USAGE
   $ sk COMMAND
@@ -91,7 +91,7 @@ USAGE
 * [`sk find-pops APP`](#sk-find-pops-app)
 * [`sk generate-customer-config`](#sk-generate-customer-config)
 * [`sk generate-pop-config APP`](#sk-generate-pop-config-app)
-* [`sk help [COMMANDS]`](#sk-help-commands)
+* [`sk help [COMMAND]`](#sk-help-command)
 * [`sk login [APP]`](#sk-login-app)
 * [`sk onboarding CUSTOMERPATH`](#sk-onboarding-customerpath)
 * [`sk param-diff PAGEURL`](#sk-param-diff-pageurl)
@@ -309,16 +309,16 @@ EXAMPLES
   $ sk generate-pop-config --coverage 95 --pop-limit 6 --traffic-share 2 --deploy appName
 ```
 
-## `sk help [COMMANDS]`
+## `sk help [COMMAND]`
 
 Display help for sk.
 
 ```
 USAGE
-  $ sk help [COMMANDS] [-n]
+  $ sk help [COMMAND] [-n]
 
 ARGUMENTS
-  COMMANDS  Command to show help for.
+  COMMAND  Command to show help for.
 
 FLAGS
   -n, --nested-commands  Include all nested commands in the output.
@@ -327,7 +327,7 @@ DESCRIPTION
   Display help for sk.
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.5/src/commands/help.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.18/src/commands/help.ts)_
 
 ## `sk login [APP]`
 

package/dist/commands/find-pops.js

@@ -17,9 +17,9 @@ class FindPops extends core_1.Command {
     static description = 'Get IPs for all fastly PoPs';
     static args = {
         [cli_parameters_1.CLIParameters.AppName]: core_1.Args.string({
-            name: cli_parameters_1.CLIParameters.AppName,
-            required: true,
-            description: 'The customers appName',
+            name: cli_parameters_1.CLIParameters.AppName, // name of arg to show in help and reference with args[name]
+            required: true, // make the arg required with `required: true`
+            description: 'The customers appName', // help description
             hidden: false, // hide this arg from help
         }),
     };
@@ -65,7 +65,7 @@ class FindPops extends core_1.Command {
                     Host: `${app}.app.baqend.com`,
                     authorization: `BAT ${token}`,
                 },
-                timeout: 10000,
+                timeout: 10_000,
             });
             const servedBy = resp.headers.get('x-served-by');
             if (resp.status !== 200 || !servedBy) {

package/dist/commands/generate-customer-config.d.ts

@@ -1,10 +1,10 @@
-import { Command } from '@oclif/core';
+import { Command } from "@oclif/core";
 export default class GenerateCustomerConfig extends Command {
     static description: string;
+    static examples: string[];
     static flags: {
         app: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
         customersDir: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
     };
-    static examples: string[];
     run(): Promise<void>;
 }

package/dist/commands/generate-customer-config.js

@@ -4,23 +4,23 @@ const core_1 = require("@oclif/core");
 const cli_parameters_1 = require("../models/cli-parameters");
 const customer_config_1 = require("../services/customer-config");
 class GenerateCustomerConfig extends core_1.Command {
-    static description = 'Generates a customer config guided by a wizard 🧙‍';
+    static description = "Generates a customer config guided by a wizard 🧙‍";
+    static examples = [
+        `$ sk generate-customer-config -${cli_parameters_1.CLIParametersChar.AppName} <${cli_parameters_1.CLIParameters.AppName}> -${cli_parameters_1.CLIParametersChar.CustomersDir} <${cli_parameters_1.CLIParameters.CustomersDir}>`,
+        `$ sk generate-customer-config -${cli_parameters_1.CLIParametersChar.AppName} ${cli_parameters_1.CLIParametersExample.AppName} -${cli_parameters_1.CLIParametersChar.CustomersDir} ${cli_parameters_1.CLIParametersExample.CustomersDir}`,
+    ];
     static flags = {
         [cli_parameters_1.CLIParameters.AppName]: core_1.Flags.string({
-            description: `The SK app name which is also being used the config output directory name (kebab-case)`,
             char: cli_parameters_1.CLIParametersChar.AppName,
+            description: "The SK app name which is also being used the config output directory name (kebab-case)",
         }),
         [cli_parameters_1.CLIParameters.CustomersDir]: core_1.Flags.string({
+            char: cli_parameters_1.CLIParametersChar.CustomersDir,
             description: `Name of the sk-onboarding directory where all customer configs are being stored (default: "${cli_parameters_1.CLIParametersExample.CustomersDir}")`,
-            char: cli_parameters_1.CLIParametersChar.CustomersDir
         }),
     };
-    static examples = [
-        `$ sk generate-customer-config -${cli_parameters_1.CLIParametersChar.AppName} <${cli_parameters_1.CLIParameters.AppName}> -${cli_parameters_1.CLIParametersChar.CustomersDir} <${cli_parameters_1.CLIParameters.CustomersDir}>`,
-        `$ sk generate-customer-config -${cli_parameters_1.CLIParametersChar.AppName} ${cli_parameters_1.CLIParametersExample.AppName} -${cli_parameters_1.CLIParametersChar.CustomersDir} ${cli_parameters_1.CLIParametersExample.CustomersDir}`,
-    ];
     async run() {
-        const { flags: { app, customersDir } } = await this.parse(GenerateCustomerConfig);
+        const { flags: { app, customersDir }, } = await this.parse(GenerateCustomerConfig);
         const context = new customer_config_1.CustomerConfigServiceContext(app, customersDir);
         const customerConfigService = await new customer_config_1.CustomerConfigServiceFactory(context).buildService();
         await customerConfigService.generateConfig();

package/dist/commands/generate-pop-config.d.ts

@@ -1,4 +1,4 @@
-import { Command } from '@oclif/core';
+import { Command } from "@oclif/core";
 export default class GeneratePopConfig extends Command {
     static args: {
         app: import("@oclif/core/lib/interfaces").Arg<string, Record<string, unknown>>;
@@ -8,9 +8,9 @@ export default class GeneratePopConfig extends Command {
     static flags: {
         coverage: import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces").CustomOptions>;
         deploy: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        'pop-limit': import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces").CustomOptions>;
-        'traffic-share': import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces").CustomOptions>;
-        'use-rum': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        "pop-limit": import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces").CustomOptions>;
+        "traffic-share": import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces").CustomOptions>;
+        "use-rum": import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     };
     createPopPrewarmingCode(popConfig: string): Promise<string>;
     deployPrewarmingConfig(app: string, config: string, deploy: boolean | undefined): Promise<void>;

package/dist/commands/generate-pop-config.js

@@ -11,54 +11,113 @@ const cli_2 = require("../services/cli");
 const config_api_service_1 = tslib_1.__importDefault(require("../services/config-api-service"));
 const diff_service_1 = require("../services/diff-service");
 const POP_REMAPPING = {
-    HHN: 'FRA',
+    HHN: "FRA",
 };
 const SHIELDS = [
-    { condition: () => true, pop: 'FRA', shield: 'Default Shield' },
-    { condition: ({ region }) => region.startsWith('US'), pop: 'LGA', shield: 'United States Shield' },
-    { condition: ({ region }) => region.startsWith('SA'), pop: 'GRU', shield: 'South America Shield' },
-    { condition: ({ region }) => region.startsWith('APAC'), pop: 'SYD', shield: 'APAC Shield' },
-    { condition: ({ pop }) => ['KUL', 'QPG'].includes(pop), pop: 'QPG', shield: 'Singapore Shield' },
-    { condition: ({ pop }) => ['HKG', 'ICN', 'MNL'].includes(pop), pop: 'HKG', shield: 'Hongkong Shield' },
-    { condition: ({ region }) => region === 'Asia-South', pop: 'DEL', shield: 'Asia South Shield' },
-    { condition: ({ region }) => region === 'North-America', pop: 'YYZ', shield: 'North America Shield' },
-    { condition: ({ pop }) => ['DXB', 'FJR'].includes(pop), pop: 'FJR', shield: 'United Arab Emirates Shield' },
-    { condition: ({ region }) => region === 'South-Africa', pop: 'JNB', shield: 'South Africa Shield' },
+    { condition: () => true, pop: "FRA", shield: "Default Shield" },
+    {
+        condition: ({ region }) => region.startsWith("US"),
+        pop: "LGA",
+        shield: "United States Shield",
+    },
+    {
+        condition: ({ region }) => region.startsWith("SA"),
+        pop: "GRU",
+        shield: "South America Shield",
+    },
+    {
+        condition: ({ region }) => region.startsWith("APAC"),
+        pop: "SYD",
+        shield: "APAC Shield",
+    },
+    {
+        condition: ({ pop }) => ["KUL", "QPG"].includes(pop),
+        pop: "QPG",
+        shield: "Singapore Shield",
+    },
+    {
+        condition: ({ pop }) => ["HKG", "ICN", "MNL"].includes(pop),
+        pop: "HKG",
+        shield: "Hongkong Shield",
+    },
+    {
+        condition: ({ region }) => region === "Asia-South",
+        pop: "DEL",
+        shield: "Asia South Shield",
+    },
+    {
+        condition: ({ region }) => region === "North-America",
+        pop: "YYZ",
+        shield: "North America Shield",
+    },
+    {
+        condition: ({ pop }) => ["DXB", "FJR"].includes(pop),
+        pop: "FJR",
+        shield: "United Arab Emirates Shield",
+    },
+    {
+        condition: ({ region }) => region === "South-Africa",
+        pop: "JNB",
+        shield: "South Africa Shield",
+    },
 ];
-const percentageFormatter = new Intl.NumberFormat('en-US', { minimumFractionDigits: 1, style: 'percent' });
+const percentageFormatter = new Intl.NumberFormat("en-US", {
+    minimumFractionDigits: 1,
+    style: "percent",
+});
 class GeneratePopConfig extends core_1.Command {
     static args = {
         [cli_parameters_1.CLIParameters.AppName]: core_1.Args.string({
-            description: 'The customers appName',
-            hidden: false,
-            name: cli_parameters_1.CLIParameters.AppName,
+            description: "The customers appName", // help description
+            hidden: false, // hide this arg from help
+            name: cli_parameters_1.CLIParameters.AppName, // name of arg to show in help and reference with args[name]
             required: true, // make the arg required with `required: true`
         }),
     };
-    static description = 'Generate a pop config for the given app';
+    static description = "Generate a pop config for the given app";
     static examples = [
         `$ sk generate-pop-config <${cli_parameters_1.CLIParameters.AppName}>`,
         `$ sk generate-pop-config --use-rum <${cli_parameters_1.CLIParameters.AppName}>`,
-        '$ sk generate-pop-config --coverage 95 appName',
-        '$ sk generate-pop-config --no-deploy appName',
-        '$ sk generate-pop-config --deploy appName',
-        '$ sk generate-pop-config --coverage 95 --pop-limit 6 --traffic-share 2 --deploy appName',
+        "$ sk generate-pop-config --coverage 95 appName",
+        "$ sk generate-pop-config --no-deploy appName",
+        "$ sk generate-pop-config --deploy appName",
+        "$ sk generate-pop-config --coverage 95 --pop-limit 6 --traffic-share 2 --deploy appName",
     ];
     static flags = {
-        coverage: core_1.Flags.integer({ char: 'c', default: 95, description: 'The percentage of traffic which should be covered through prewarming.' }),
-        deploy: core_1.Flags.boolean({ allowNo: true, char: 'd', description: 'Default it diffs with the deployed config and ask for deployment. If the flag is passed deployment will be skipped or forced.' }),
-        'pop-limit': core_1.Flags.integer({ char: 'p', default: 5, description: 'The maximal pop count which should prewarmed.' }),
-        'traffic-share': core_1.Flags.integer({ char: 't', default: 5, description: 'The minimum traffic share in percent a pop must have to be actually prewarmed.' }),
-        'use-rum': core_1.Flags.boolean({ char: 'r', default: false, description: 'Compute the pop statistics based on RUM. Otherwise the real Speed Kit traffic is used.' }),
+        coverage: core_1.Flags.integer({
+            char: "c",
+            default: 95,
+            description: "The percentage of traffic which should be covered through prewarming.",
+        }),
+        deploy: core_1.Flags.boolean({
+            allowNo: true,
+            char: "d",
+            description: "Default it diffs with the deployed config and ask for deployment. If the flag is passed deployment will be skipped or forced.",
+        }),
+        "pop-limit": core_1.Flags.integer({
+            char: "p",
+            default: 5,
+            description: "The maximal pop count which should prewarmed.",
+        }),
+        "traffic-share": core_1.Flags.integer({
+            char: "t",
+            default: 5,
+            description: "The minimum traffic share in percent a pop must have to be actually prewarmed.",
+        }),
+        "use-rum": core_1.Flags.boolean({
+            char: "r",
+            default: false,
+            description: "Compute the pop statistics based on RUM. Otherwise the real Speed Kit traffic is used.",
+        }),
     };
     async createPopPrewarmingCode(popConfig) {
-        const revalidationTemplate = await (0, file_helper_1.readLocalFile)(__dirname, '../templates/speedKit.Revalidated.js');
-        const pops = await (0, file_helper_1.readLocalFile)(__dirname, '../templates/pops.js');
+        const revalidationTemplate = await (0, file_helper_1.readLocalFile)(__dirname, "../templates/speedKit.Revalidated.js");
+        const pops = await (0, file_helper_1.readLocalFile)(__dirname, "../templates/pops.js");
         popConfig = pops + popConfig;
-        return revalidationTemplate.replace('{{config}}', popConfig);
+        return revalidationTemplate.replace("{{config}}", popConfig);
     }
     async deployPrewarmingConfig(app, config, deploy) {
-        const moduleName = 'speedKit.Revalidated';
+        const moduleName = "speedKit.Revalidated";
         const db = await cli_1.account.login({ app });
         const configService = new config_api_service_1.default(db, app);
         const cliService = new cli_2.CliServiceFactory().getService();
@@ -66,19 +125,21 @@ class GeneratePopConfig extends core_1.Command {
         const popPrewarmingCode = await this.createPopPrewarmingCode(config);
         const popPrewarmingCodePath = await diffService.writeContentToTemporalFile(`generated_${moduleName}`, popPrewarmingCode);
         const remoteConfig = await configService.getRemoteModule(moduleName);
-        const doDeploy = deploy ?? await diffService.shouldDeployModule(moduleName, remoteConfig, popPrewarmingCodePath);
+        const doDeploy = deploy ??
+            (await diffService.shouldDeployModule(moduleName, remoteConfig, popPrewarmingCodePath));
         if (doDeploy) {
-            const content = await (0, promises_1.readFile)(popPrewarmingCodePath, { encoding: 'utf8' });
+            const content = await (0, promises_1.readFile)(popPrewarmingCodePath, {
+                encoding: "utf8",
+            });
             await configService.saveRemoteModule(content, moduleName);
             this.log(`Changes for module ${moduleName} were updated successfully`);
         }
     }
     async run() {
-        const { args: { app }, flags: { coverage, deploy, 'pop-limit': popLimit, 'traffic-share': minimalShare, 'use-rum': useRum } } = await this.parse(GeneratePopConfig);
+        const { args: { app }, flags: { coverage, deploy, "pop-limit": popLimit, "traffic-share": minimalShare, "use-rum": useRum, }, } = await this.parse(GeneratePopConfig);
         const athenaService = new athena_service_1.AthenaService();
         const result = await athenaService.getUsedPopsPerOrigin(app, useRum);
-        const originStats = this.generateOriginStats(result)
-            .filter(stats => stats.hits > 1000);
+        const originStats = this.generateOriginStats(result).filter((stats) => stats.hits > 1000);
         this.printStats(originStats, coverage / 100, minimalShare / 100, popLimit);
         const popConfig = this.generatePopConfig(originStats, coverage / 100, minimalShare / 100, popLimit);
         await this.deployPrewarmingConfig(app, popConfig, deploy);
@@ -89,9 +150,13 @@ class GeneratePopConfig extends core_1.Command {
     computeCoverageAndShare(totalHits, segmentedStats) {
         segmentedStats = segmentedStats.sort(this.byHitsDesc);
         let segmentHits = 0;
-        return segmentedStats.map(segment => {
+        return segmentedStats.map((segment) => {
             segmentHits += segment.hits;
-            return { ...segment, coverage: segmentHits / totalHits, share: segment.hits / totalHits };
+            return {
+                ...segment,
+                coverage: segmentHits / totalHits,
+                share: segment.hits / totalHits,
+            };
         });
     }
     generateOriginStats(result) {
@@ -99,38 +164,51 @@ class GeneratePopConfig extends core_1.Command {
         for (let { hits, origin, pop, region } of result) {
             pop = POP_REMAPPING[pop] ?? pop;
             const shieldInfo = this.getShieldInfo(region, pop);
-            const stats = originStats[origin] = originStats[origin] ?? {
+            // eslint-disable-next-line no-multi-assign
+            const stats = (originStats[origin] = originStats[origin] ?? {
                 hits: 0,
                 origin,
                 pops: {},
                 regions: {},
                 shields: {},
-            };
+            });
             stats.hits += hits;
-            const regionStats = stats.regions[region] = stats.regions[region] ?? { hits: 0, region };
+            // eslint-disable-next-line no-multi-assign
+            const regionStats = (stats.regions[region] = stats.regions[region] ?? {
+                hits: 0,
+                region,
+            });
             regionStats.hits += hits;
-            const shieldStats = stats.shields[shieldInfo.shield] = stats.shields[shieldInfo.shield] ?? { ...shieldInfo, hits: 0 };
+            // eslint-disable-next-line no-multi-assign
+            const shieldStats = (stats.shields[shieldInfo.shield] = stats.shields[shieldInfo.shield] ?? { ...shieldInfo, hits: 0 });
             shieldStats.hits += hits;
-            const popStats = stats.pops[pop] = stats.pops[pop] ?? { hits: 0, pop, region, shield: shieldInfo.pop };
+            // eslint-disable-next-line no-multi-assign
+            const popStats = (stats.pops[pop] = stats.pops[pop] ?? {
+                hits: 0,
+                pop,
+                region,
+                shield: shieldInfo.pop,
+            });
             popStats.hits += hits;
         }
-        return Object.values(originStats).map(stats => ({
+        return Object.values(originStats)
+            .map((stats) => ({
             hits: stats.hits,
             origin: stats.origin,
             pops: this.computeCoverageAndShare(stats.hits, Object.values(stats.pops)),
             regions: this.computeCoverageAndShare(stats.hits, Object.values(stats.regions)),
             shields: this.computeCoverageAndShare(stats.hits, Object.values(stats.shields)),
-        })).sort(this.byHitsDesc);
+        }))
+            .sort(this.byHitsDesc);
     }
     generatePopConfig(originStats, coverage, minimalShare, popLimit) {
         const originConfigs = { DEFAULT: [] };
         for (const originStat of originStats) {
-            originConfigs[originStat.origin] = this.generatePrewarmingConfig(originStat, coverage, minimalShare, popLimit).pops
-                .map(pop => 'POP.' + pop);
+            originConfigs[originStat.origin] = this.generatePrewarmingConfig(originStat, coverage, minimalShare, popLimit).pops.map((pop) => "POP." + pop);
         }
-        const serializedConfig = JSON.stringify(originConfigs, null, '  ')
-            .replaceAll(/"(POP.*?)"/g, '$1')
-            .replaceAll(/\[(.*?)]/gs, match => match.replaceAll(/\s+/gs, ' '));
+        const serializedConfig = JSON.stringify(originConfigs, null, "  ")
+            .replaceAll(/"(POP.*?)"/g, "$1")
+            .replaceAll(/\[(.*?)]/gs, (match) => match.replaceAll(/\s+/gs, " "));
         return `/* global POP */
 /** @type PopConfig */
 const ORIGIN_POPS = ${serializedConfig}`;
@@ -152,12 +230,17 @@ const ORIGIN_POPS = ${serializedConfig}`;
         let shieldCoverage = 0;
         for (const shieldStats of originStat.shields) {
             // if we are pre warming the shield through an edge pop we increase the edge coverage of the edge and the shield pop
-            const shieldPop = originStat.pops.find(pop => pop.pop === shieldStats.pop);
+            const shieldPop = originStat.pops.find((pop) => pop.pop === shieldStats.pop);
             edgeCoverage += shieldPop?.share ?? 0; // in the case the shield pop does not receive any direct traffic
             shieldCoverage += shieldStats.share;
             let { pop } = shieldStats;
             // We try to use the top edge pop of the shield, if that pop still has enough traffic
-            const bestEdgePopOfShield = originStat.pops.find(popStats => popStats.shield == pop && popStats.pop != pop && popStats.share > minimalShare);
+            const bestEdgePopOfShield = originStat.pops.find((popStats) => 
+            // eslint-disable-next-line eqeqeq
+            popStats.shield == pop &&
+                // eslint-disable-next-line eqeqeq
+                popStats.pop != pop &&
+                popStats.share > minimalShare);
             if (bestEdgePopOfShield) {
                 edgeCoverage += bestEdgePopOfShield.share;
                 pop = bestEdgePopOfShield.pop;
@@ -167,8 +250,11 @@ const ORIGIN_POPS = ${serializedConfig}`;
                 break;
         }
         for (const pop of originStat.pops) {
-            if (pops.length < popLimit // when the shield pre warming list is short, we can add additional big traffic pops
-                && pop.share > minimalShare && !pops.includes(pop.pop) && pop.shield != pop.pop) {
+            if (pops.length < popLimit && // when the shield pre warming list is short, we can add additional big traffic pops
+                pop.share > minimalShare &&
+                !pops.includes(pop.pop) &&
+                // eslint-disable-next-line eqeqeq
+                pop.shield != pop.pop) {
                 pops.push(pop.pop);
                 edgeCoverage += pop.share;
             }
@@ -196,35 +282,39 @@ const ORIGIN_POPS = ${serializedConfig}`;
         let shieldingRequired = false;
         for (const originStat of originStats) {
             this.log(`${originStat.origin} ${originStat.hits}`);
-            this.log('  Regions:');
+            this.log("  Regions:");
             for (const regionStats of originStat.regions) {
                 this.log(`    ${regionStats.region} ${regionStats.hits} ${percentageFormatter.format(regionStats.coverage)}`);
-                if (regionStats.coverage >= coverage || regionStats.share < minimalShare)
+                if (regionStats.coverage >= coverage ||
+                    regionStats.share < minimalShare)
                     break;
             }
-            this.log('  Shields:');
+            this.log("  Shields:");
             for (const shieldStats of originStat.shields) {
                 this.log(`    ${shieldStats.shield} (${shieldStats.pop}) ${shieldStats.hits} ${percentageFormatter.format(shieldStats.coverage)}`);
-                if (shieldStats.coverage >= coverage || shieldStats.share < minimalShare)
+                if (shieldStats.coverage >= coverage ||
+                    shieldStats.share < minimalShare)
                     break;
             }
-            this.log('  Pops:');
+            this.log("  Pops:");
             for (const popStats of originStat.pops) {
                 this.log(`    ${popStats.pop} ${popStats.hits} ${percentageFormatter.format(popStats.coverage)} - shield: ${popStats.shield}`);
                 if (popStats.coverage >= coverage || popStats.share < minimalShare)
                     break;
             }
             const config = this.generatePrewarmingConfig(originStat, coverage, minimalShare, popLimit);
-            this.log('  --------------------');
+            this.log("  --------------------");
             if (config.requiresShielding)
-                this.log('  Final shield coverage: ' + percentageFormatter.format(config.shieldCoverage));
-            this.log('  Final edge coverage:   ' + percentageFormatter.format(config.edgeCoverage));
-            this.log('  Final pop list:        ' + config.pops.join(', '));
-            this.log('');
+                this.log("  Final shield coverage: " +
+                    percentageFormatter.format(config.shieldCoverage));
+            this.log("  Final edge coverage:   " +
+                percentageFormatter.format(config.edgeCoverage));
+            this.log("  Final pop list:        " + config.pops.join(", "));
+            this.log("");
             shieldingRequired ||= config.requiresShielding;
         }
         if (shieldingRequired) {
-            this.warn('The prewarming configuration needs enabled shielding to work properly!');
+            this.warn("The prewarming configuration needs enabled shielding to work properly!");
         }
     }
 }

package/dist/commands/login.js

@@ -10,7 +10,7 @@ class Login extends core_1.Command {
     static description = 'Login to your app';
     static args = {
         [cli_parameters_1.CLIParameters.AppName]: core_1.Args.string({
-            name: cli_parameters_1.CLIParameters.AppName,
+            name: cli_parameters_1.CLIParameters.AppName, // name of arg to show in help and reference with args[name]
             required: false,
             default: 'bbq',
             description: 'The customers appName', // help description

package/dist/commands/pop-prewarm.js

@@ -11,9 +11,9 @@ class PopPrewarm extends core_1.Command {
     static description = 'Pre-warm Fastly PoPs';
     static args = {
         [cli_parameters_1.CLIParameters.AppName]: core_1.Args.string({
-            name: cli_parameters_1.CLIParameters.AppName,
-            required: true,
-            description: 'The customers appName',
+            name: cli_parameters_1.CLIParameters.AppName, // name of arg to show in help and reference with args[name]
+            required: true, // make the arg required with `required: true`
+            description: 'The customers appName', // help description
             hidden: false, // hide this arg from help
         }),
     };

package/dist/commands/prewarm.js

@@ -13,13 +13,13 @@ class Prewarm extends core_1.Command {
     static description = 'Pre-warm Fastly';
     static args = {
         [cli_parameters_1.CLIParameters.AppName]: core_1.Args.string({
-            name: cli_parameters_1.CLIParameters.AppName,
-            required: true,
+            name: cli_parameters_1.CLIParameters.AppName, // name of arg to show in help and reference with args[name]
+            required: true, // make the arg required with `required: true`
             description: 'The customer app name', // help description
         }),
         [cli_parameters_1.CLIParameters.Path]: core_1.Args.string({
-            name: cli_parameters_1.CLIParameters.Path,
-            required: true,
+            name: cli_parameters_1.CLIParameters.Path, // name of arg to show in help and reference with args[name]
+            required: true, // make the arg required with `required: true`
             description: 'path to prewarmFile', // help description
         }),
     };

package/dist/commands/wpt-launcher.js

@@ -9,11 +9,11 @@ class WptLauncher extends core_1.Command {
     static description = 'Analyze the performance impact that Speed Kit has compared to the original version.';
     static args = {
         [cli_parameters_1.CLIParameters.Urls]: core_1.Args.string({
-            name: cli_parameters_1.CLIParameters.Urls,
+            name: cli_parameters_1.CLIParameters.Urls, // name of arg to show in help and reference with args[name]
             required: true, // make the arg required with `required: true`
         }),
         [cli_parameters_1.CLIParameters.TestId]: core_1.Args.string({
-            name: cli_parameters_1.CLIParameters.TestId,
+            name: cli_parameters_1.CLIParameters.TestId, // name of arg to show in help and reference with args[name]
             required: true, // make the arg required with `required: true`
         }),
     };

package/dist/dummy.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/dummy.spec.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// Require the assert module from Chai
+const { expect } = require('chai');
+// Dummy function to test
+function add(a, b) {
+    return a + b;
+}
+// Describe your test suite
+describe('(dummy) add function test', () => {
+    // It block describes a single test
+    it('should add two numbers', () => {
+        // Call our function with some test inputs
+        const result = add(2, 3);
+        // Assert that our function returned the correct value
+        expect(result).to.equal(5);
+    });
+    // Add more tests here
+});

package/dist/models/cli-parameters.js

@@ -75,8 +75,8 @@ exports.CLI_CONFIG_NAME = {
 };
 exports.CLI_CUSTOMER_CONFIG = {
     [CLIParameters.CustomerPath]: core_1.Args.directory({
-        name: CLIParameters.CustomerPath,
-        required: true,
+        name: CLIParameters.CustomerPath, // name of arg to show in help and reference with args[name]
+        required: true, // make the arg required with `required: true`
         description: 'The customer config path', // help description
     }),
 };

package/dist/services/cli/cli-service.d.ts

@@ -6,10 +6,10 @@ export declare class CliService implements CliServiceInterface {
     style: chalk.Chalk & chalk.ChalkFunction & {
         supportsColor: false | chalk.ColorSupport;
         Level: chalk.Level;
-        Color: ("black" | "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "blackBright" | "redBright" | "greenBright" | "yellowBright" | "blueBright" | "magentaBright" | "cyanBright" | "whiteBright") | ("bgBlack" | "bgRed" | "bgGreen" | "bgYellow" | "bgBlue" | "bgMagenta" | "bgCyan" | "bgWhite" | "bgGray" | "bgGrey" | "bgBlackBright" | "bgRedBright" | "bgGreenBright" | "bgYellowBright" | "bgBlueBright" | "bgMagentaBright" | "bgCyanBright" | "bgWhiteBright");
-        ForegroundColor: "black" | "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "blackBright" | "redBright" | "greenBright" | "yellowBright" | "blueBright" | "magentaBright" | "cyanBright" | "whiteBright";
-        BackgroundColor: "bgBlack" | "bgRed" | "bgGreen" | "bgYellow" | "bgBlue" | "bgMagenta" | "bgCyan" | "bgWhite" | "bgGray" | "bgGrey" | "bgBlackBright" | "bgRedBright" | "bgGreenBright" | "bgYellowBright" | "bgBlueBright" | "bgMagentaBright" | "bgCyanBright" | "bgWhiteBright";
-        Modifiers: "hidden" | "bold" | "reset" | "dim" | "italic" | "underline" | "inverse" | "strikethrough" | "visible";
+        Color: ("white" | "black" | "blue" | "yellow" | "green" | "red" | "magenta" | "cyan" | "gray" | "blackBright" | "redBright" | "greenBright" | "yellowBright" | "blueBright" | "magentaBright" | "cyanBright" | "whiteBright" | "grey") | ("bgBlack" | "bgRed" | "bgGreen" | "bgYellow" | "bgBlue" | "bgMagenta" | "bgCyan" | "bgWhite" | "bgGray" | "bgBlackBright" | "bgRedBright" | "bgGreenBright" | "bgYellowBright" | "bgBlueBright" | "bgMagentaBright" | "bgCyanBright" | "bgWhiteBright" | "bgGrey");
+        ForegroundColor: "white" | "black" | "blue" | "yellow" | "green" | "red" | "magenta" | "cyan" | "gray" | "blackBright" | "redBright" | "greenBright" | "yellowBright" | "blueBright" | "magentaBright" | "cyanBright" | "whiteBright" | "grey";
+        BackgroundColor: "bgBlack" | "bgRed" | "bgGreen" | "bgYellow" | "bgBlue" | "bgMagenta" | "bgCyan" | "bgWhite" | "bgGray" | "bgBlackBright" | "bgRedBright" | "bgGreenBright" | "bgYellowBright" | "bgBlueBright" | "bgMagentaBright" | "bgCyanBright" | "bgWhiteBright" | "bgGrey";
+        Modifiers: "hidden" | "bold" | "underline" | "dim" | "italic" | "strikethrough" | "visible" | "reset" | "inverse";
         stderr: chalk.Chalk & {
             supportsColor: false | chalk.ColorSupport;
         };

package/dist/services/config-api/client.js

@@ -5,7 +5,7 @@ const https_1 = require("https");
 const node_fetch_1 = tslib_1.__importDefault(require("node-fetch"));
 const deepmerge_1 = tslib_1.__importDefault(require("deepmerge"));
 const race_1 = require("../../helpers/race");
-const REQUEST_TIMEOUT = 10000;
+const REQUEST_TIMEOUT = 10_000;
 const CONTENT_TYPE = 'application/json;charset=UTF-8';
 class Client {
     entityManagerFactory;

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

@@ -24,7 +24,7 @@ class ConfigApiService {
                 authorization: `BAT ${this.db.token}`,
                 'Content-Type': 'application/json;charset=UTF-8',
             },
-            timeout: 10000,
+            timeout: 10_000,
         };
     }
     async fetchActiveInstall(configName) {

package/dist/services/integration-api/handler/customer-config-handler.js

@@ -34,7 +34,7 @@ class CustomerConfigHandler extends file_handler_1.default {
             throw new customer_config_error_1.default('please specify env TEST_APP in your .env or configFile file');
         }
         const customerConfigContext = {
-            module: { exports: {} },
+            module: { exports: {} }, // make TEST_APP available for vm
             process: {
                 env: { TEST_APP: this.testApp } // make TEST_APP available for vm
             }

package/dist/services/integration-api/struct/customer-config-file.js

@@ -18,7 +18,7 @@ class CustomerConfigFile extends file_1.default {
     }
     updateConfigByContent() {
         const customerConfigContext = {
-            module: { exports: {} },
+            module: { exports: {} }, // make TEST_APP available for vm
             process: {
                 env: { TEST_APP: process.env.TEST_APP } // make TEST_APP available for vm
             }

package/dist/services/onboarding/onboarding-service.js

@@ -42,7 +42,7 @@ class OnboardingService {
         const browser = await puppeteer_extra_1.default.launch({
             devtools: true,
             defaultViewport: null,
-            headless: false,
+            headless: false, /* ignoreDefaultArgs: true, */
             executablePath: this.browserContext.chromePath,
             args: this.browserContext.browserArgs,
         });

package/dist/services/prewarm-service.js

@@ -23,7 +23,7 @@ class PrewarmService {
                 authorization: `BAT ${token}`,
                 'Accept-Encoding': 'gzip, deflate, br',
             },
-            timeout: 10000,
+            timeout: 10_000,
         });
     }
     // eslint-disable-next-line max-params
@@ -41,7 +41,7 @@ class PrewarmService {
                 authorization: `BAT ${token}`,
                 'Accept-Encoding': 'gzip, deflate, br',
             },
-            timeout: 10000,
+            timeout: 10_000,
         });
     }
     static chunk(arr, len) {

package/oclif.manifest.json

@@ -696,5 +696,5 @@
       ]
     }
   },
-  "version": "2.8.0"
+  "version": "2.10.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@speedkit/cli",
   "description": "Speed Kit CLI",
-  "version": "2.8.0",
+  "version": "2.10.0",
   "author": {
     "name": "Baqend.com",
     "email": "info@baqend.com"
@@ -15,16 +15,14 @@
   },
   "scripts": {
     "prepare": "husky install",
-    "lint": "eslint --ext .ts,.vue --ignore-path .gitignore src",
-    "lint-fix": "eslint --fix --ext .ts,.vue --ignore-path .gitignore src",
     "prebuild": "shx rm -rf dist",
-    "build": "tsc -b && copyfiles -u 1 src/**/*hbs ./dist && copyfiles -u 1 src/**/*js ./dist && npm run build-dashboard",
-    "build-dashboard": "copyfiles -u 1 src/services/onboarding/dashboard/frontend-dist/**/*.html dist && copyfiles -u 1 src/services/onboarding/dashboard/frontend-dist/**/*.js dist && copyfiles -u 1 src/services/onboarding/dashboard/frontend-dist/**/*.css dist",
+    "build": "tsc -b && copyfiles -u 1 src/**/*hbs ./dist && copyfiles -u 1 src/**/*js ./dist && npm run build:dashboard",
+    "build:dashboard": "copyfiles -u 1 src/services/onboarding/dashboard/frontend-dist/**/*.html dist && copyfiles -u 1 src/services/onboarding/dashboard/frontend-dist/**/*.js dist && copyfiles -u 1 src/services/onboarding/dashboard/frontend-dist/**/*.css dist",
     "postbuild": "oclif manifest && oclif readme",
     "prepack": "npm run build",
-    "postpack": "rimraf rm -f oclif.manifest.json",
-    "test": "mocha \"test/**/*.test.ts\"",
-    "coverage": "nyc --extension .ts mocha \"test/**/*.test.ts\""
+    "test": "mocha --reporter mocha-junit-reporter --reporter-options mochaFile=junit.xml",
+    "coverage": "nyc mocha",
+    "coverage:report": "nyc --reporter cobertura mocha"
   },
   "bin": {
     "sk": "bin/run",
@@ -37,10 +35,9 @@
     "oclif"
   ],
   "files": [
-    "/bin",
-    "/dist",
-    "/npm-shrinkwrap.json",
-    "/oclif.manifest.json"
+    "dist",
+    "oclif.manifest.json",
+    "CHANGELOG.md"
   ],
   "oclif": {
     "commands": "./dist/commands",
@@ -62,14 +59,14 @@
   "types": "dist/index.d.ts",
   "type": "commonjs",
   "dependencies": {
-    "@aws-sdk/client-athena": "^3.204.0",
+    "@aws-sdk/client-athena": "^3.529",
     "@inquirer/prompts": "^3.0",
-    "@oclif/core": "^3.20",
+    "@oclif/core": "^3.23",
     "@oclif/plugin-autocomplete": "^3.0",
     "@oclif/plugin-help": "^6.0",
     "@oclif/plugin-not-found": "^3.0",
     "@oclif/plugin-warn-if-update-available": "^3.0",
-    "axios": "^1.4.0",
+    "axios": "^1.6",
     "baqend": "^3.4",
     "chalk": "^4",
     "clipboardy-cjs": "^3.0.0",
@@ -78,54 +75,63 @@
     "diff": "^5.1.0",
     "dom-serializer": "2.0.0",
     "domhandler": "5.0.3",
-    "domutils": "3.0.1",
-    "dotenv": "^16.0.3",
+    "domutils": "^3.1",
+    "dotenv": "^16.4",
     "extract-zip": "^2.0.1",
     "fs-extra": "^10.1.0",
     "handlebars": "^4.7",
     "htmlparser2": "8.0",
     "json2csv": "^6.0.0-alpha.2",
-    "nock": "^13.3.8",
     "node-fetch": "^2.6",
     "parse5": "7.1",
     "parse5-htmlparser2-tree-adapter": "7.0.0",
-    "puppeteer": "^21.5",
-    "puppeteer-core": "^21.3",
+    "puppeteer": "^21.11",
+    "puppeteer-core": "^22.4",
     "puppeteer-extra": "^3.3",
     "puppeteer-extra-plugin-user-preferences": "^2.4",
     "strip-comments": "^2.0.1",
-    "ts-sinon": "^2.0.2",
     "uuid": "^8.3.2"
   },
   "devDependencies": {
     "@commitlint/cli": "^17.7.1",
     "@commitlint/config-conventional": "^17.7.0",
+    "@istanbuljs/nyc-config-typescript": "^1.0.2",
     "@oclif/prettier-config": "^0.2.1",
     "@oclif/test": "^3",
     "@types/chai": "^4.3.10",
     "@types/fs-extra": "^9.0.13",
-    "@types/mocha": "^10.0.4",
+    "@types/mocha": "^10.0",
     "@types/mock-fs": "^4.13.4",
-    "@types/node": "^18.7.13",
+    "@types/node": "^18.19",
     "@types/uuid": "^8.3.4",
-    "chai": "^4.3.6",
+    "chai": "^4.4",
     "copyfiles": "^2.4.1",
-    "esbuild": "^0.15.5",
-    "eslint": "^8.22.0",
-    "eslint-config-oclif": "^5.0.0",
-    "eslint-config-oclif-typescript": "^3.0.13",
-    "eslint-config-prettier": "^9.0.0",
+    "esbuild": "^0.20",
+    "eslint": "^8.57",
+    "eslint-config-oclif": "^5.1",
+    "eslint-config-oclif-typescript": "^3.1",
+    "eslint-config-prettier": "^9.1",
+    "eslint-plugin-prettier": "^5.1",
     "globby": "^11",
     "husky": "^8.0.3",
+    "lint-staged": "^14.0.1",
     "mocha": "^10.1.0",
+    "mocha-junit-reporter": "^2.2.1",
+    "nock": "^13.5",
+    "ts-sinon": "^2.0.2",
     "mock-fs": "^5.2.0",
     "nyc": "^15.1.0",
-    "oclif": "^4.0.3",
+    "oclif": "^4.5",
     "shx": "^0.3.4",
     "ts-mocha": "^10.0.0",
-    "ts-node": "^10.9.1",
-    "tslib": "^2.4.0",
-    "typescript": "^5.2.2",
+    "ts-node": "^10.9",
+    "tslib": "^2.6",
+    "typescript": "^5.4",
     "typescript-json-serializer": "^4.3.0"
+  },
+  "lint-staged": {
+    "*.ts": [
+      "eslint --fix"
+    ]
   }
 }

package/bin/dev.cmd

@@ -1,3 +0,0 @@
-@echo off
-
-node "%~dp0\dev" %*

package/bin/run.cmd

@@ -1,3 +0,0 @@
-@echo off
-
-node "%~dp0\run" %*