@alwaysmeticulous/cli 2.5.3 → 2.5.5

package/dist/commands/run-all-tests/run-all-tests.command.js

@@ -8,6 +8,7 @@ const common_1 = require("@alwaysmeticulous/common");
 const loglevel_1 = __importDefault(require("loglevel"));
 const client_1 = require("../../api/client");
 const test_run_api_1 = require("../../api/test-run.api");
+const command_builder_1 = require("../../command-utils/command-builder");
 const common_options_1 = require("../../command-utils/common-options");
 const config_1 = require("../../config/config");
 const deflake_tests_handler_1 = require("../../deflake-tests/deflake-tests.handler");
@@ -16,7 +17,6 @@ const commit_sha_utils_1 = require("../../utils/commit-sha.utils");
 const config_utils_1 = require("../../utils/config.utils");
 const github_summary_utils_1 = require("../../utils/github-summary.utils");
 const run_all_tests_utils_1 = require("../../utils/run-all-tests.utils");
-const sentry_utils_1 = require("../../utils/sentry.utils");
 const version_utils_1 = require("../../utils/version.utils");
 const handler = async ({ apiToken, commitSha: commitSha_, appUrl, useAssetsSnapshottedInBaseSimulation, headless, devTools, bypassCSP, diffThreshold, diffPixelThreshold, padTime, shiftTime, networkStubbing, githubSummary, parallelize, parallelTasks, deflake, useCache, testsFile, skipPauses, }) => {
     if (appUrl != null && useAssetsSnapshottedInBaseSimulation) {
@@ -131,58 +131,56 @@ const handler = async ({ apiToken, commitSha: commitSha_, appUrl, useAssetsSnaps
         process.exit(1);
     }
 };
-exports.runAllTests = {
-    command: "run-all-tests",
-    describe: "Run all replay test cases",
-    builder: {
-        apiToken: common_options_1.OPTIONS.apiToken,
-        commitSha: common_options_1.OPTIONS.commitSha,
-        appUrl: {
-            string: true,
-            description: "The URL to execute the tests against. If left absent here and in the test cases file, then will use the URL the test was originally recorded against.",
-        },
-        useAssetsSnapshottedInBaseSimulation: {
-            boolean: true,
-            description: "If present will run each session against a local server serving up previously snapshotted assets (HTML, JS, CSS etc.)" +
-                " from the base simulation/replay the test is comparing against. The sessions will then be replayed against those local urls." +
-                " This is an alternative to specifying an appUrl.",
-            default: false,
-        },
-        githubSummary: {
-            boolean: true,
-            description: "Outputs a summary page for GitHub actions",
-        },
-        parallelize: {
-            boolean: true,
-            description: "Run tests in parallel",
-        },
-        parallelTasks: {
-            number: true,
-            description: "Number of tasks to run in parallel",
-            coerce: (value) => {
-                if (typeof value === "number" && value <= 0) {
-                    return null;
-                }
-                return value;
-            },
-        },
-        deflake: {
-            boolean: true,
-            description: "Attempt to deflake failing tests",
-            default: false,
-        },
-        useCache: {
-            boolean: true,
-            description: "Use result cache",
-            default: false,
-        },
-        testsFile: {
-            string: true,
-            description: "The path to the meticulous.json file containing the list of tests you want to run." +
-                " If not set a search will be performed to find a meticulous.json file in the current directory or the nearest parent directory.",
+exports.runAllTests = (0, command_builder_1.buildCommand)("run-all-tests")
+    .details({ describe: "Run all replay test cases" })
+    .options({
+    apiToken: common_options_1.OPTIONS.apiToken,
+    commitSha: common_options_1.OPTIONS.commitSha,
+    appUrl: {
+        string: true,
+        description: "The URL to execute the tests against. If left absent here and in the test cases file, then will use the URL the test was originally recorded against.",
+    },
+    useAssetsSnapshottedInBaseSimulation: {
+        boolean: true,
+        description: "If present will run each session against a local server serving up previously snapshotted assets (HTML, JS, CSS etc.)" +
+            " from the base simulation/replay the test is comparing against. The sessions will then be replayed against those local urls." +
+            " This is an alternative to specifying an appUrl.",
+        default: false,
+    },
+    githubSummary: {
+        boolean: true,
+        description: "Outputs a summary page for GitHub actions",
+    },
+    parallelize: {
+        boolean: true,
+        description: "Run tests in parallel",
+    },
+    parallelTasks: {
+        number: true,
+        description: "Number of tasks to run in parallel",
+        coerce: (value) => {
+            if (typeof value === "number" && value <= 0) {
+                return null;
+            }
+            return value;
         },
-        ...common_options_1.COMMON_REPLAY_OPTIONS,
-        ...common_options_1.SCREENSHOT_DIFF_OPTIONS,
     },
-    handler: (0, sentry_utils_1.wrapHandler)(handler),
-};
+    deflake: {
+        boolean: true,
+        description: "Attempt to deflake failing tests",
+        default: false,
+    },
+    useCache: {
+        boolean: true,
+        description: "Use result cache",
+        default: false,
+    },
+    testsFile: {
+        string: true,
+        description: "The path to the meticulous.json file containing the list of tests you want to run." +
+            " If not set a search will be performed to find a meticulous.json file in the current directory or the nearest parent directory.",
+    },
+    ...common_options_1.COMMON_REPLAY_OPTIONS,
+    ...common_options_1.SCREENSHOT_DIFF_OPTIONS,
+})
+    .handler(handler);

package/dist/commands/screenshot-diff/screenshot-diff.command.d.ts

@@ -1,5 +1,5 @@
+/// <reference types="yargs" />
 import { AxiosInstance } from "axios";
-import { CommandModule } from "yargs";
 import { ScreenshotDiffOptions } from "../../command-utils/common-types";
 import { CompareImageResult } from "../../image/diff.utils";
 export declare class DiffError extends Error {
@@ -32,12 +32,29 @@ export declare const diffScreenshots: (options: {
     diffOptions: ScreenshotDiffOptions;
     exitOnMismatch: boolean;
 }) => Promise<ScreenshotDiffResult[]>;
-interface Options {
-    apiToken?: string | null | undefined;
-    baseSimulationId: string;
-    headSimulationId: string;
-    threshold: number;
-    pixelThreshold: number;
-}
-export declare const screenshotDiff: CommandModule<unknown, Options>;
+export declare const screenshotDiff: import("yargs").CommandModule<unknown, import("yargs").InferredOptionTypes<{
+    apiToken: {
+        string: true;
+    };
+    baseSimulationId: {
+        string: true;
+        demandOption: true;
+        alias: string;
+    };
+    headSimulationId: {
+        string: true;
+        demandOption: true;
+        alias: string;
+    };
+    threshold: {
+        readonly number: true;
+        readonly description: "Acceptable maximum proportion of changed pixels, between 0 and 1. If this proportion is exceeded then the test will fail.";
+        readonly default: 0.01;
+    };
+    pixelThreshold: {
+        readonly number: true;
+        readonly description: "A number between 0 and 1. Color/brightness differences in individual pixels will be ignored if the difference is less than this threshold. A value of 1.0 would accept any difference in color, while a value of 0.0 would accept no difference in color.";
+        readonly default: 0.01;
+    };
+}>>;
 export {};

package/dist/commands/screenshot-diff/screenshot-diff.command.js

@@ -9,12 +9,12 @@ const common_1 = require("@alwaysmeticulous/common");
 const loglevel_1 = __importDefault(require("loglevel"));
 const client_1 = require("../../api/client");
 const replay_api_1 = require("../../api/replay.api");
+const command_builder_1 = require("../../command-utils/command-builder");
 const common_options_1 = require("../../command-utils/common-options");
 const diff_utils_1 = require("../../image/diff.utils");
 const io_utils_1 = require("../../image/io.utils");
 const replays_1 = require("../../local-data/replays");
 const screenshot_diffs_1 = require("../../local-data/screenshot-diffs");
-const sentry_utils_1 = require("../../utils/sentry.utils");
 class DiffError extends Error {
     constructor(message, extras) {
         super(message);
@@ -145,25 +145,23 @@ const handler = async ({ apiToken, baseSimulationId: baseReplayId, headSimulatio
         exitOnMismatch: true,
     });
 };
-exports.screenshotDiff = {
-    command: "screenshot-diff",
-    describe: "Diff two replay screenshots",
-    builder: {
-        apiToken: {
-            string: true,
-        },
-        baseSimulationId: {
-            string: true,
-            demandOption: true,
-            alias: "baseReplayId",
-        },
-        headSimulationId: {
-            string: true,
-            demandOption: true,
-            alias: "headReplayId",
-        },
-        threshold: common_options_1.SCREENSHOT_DIFF_OPTIONS.diffThreshold,
-        pixelThreshold: common_options_1.SCREENSHOT_DIFF_OPTIONS.diffPixelThreshold,
+exports.screenshotDiff = (0, command_builder_1.buildCommand)("screenshot-diff")
+    .details({ describe: "Diff two replay screenshots" })
+    .options({
+    apiToken: {
+        string: true,
     },
-    handler: (0, sentry_utils_1.wrapHandler)(handler),
-};
+    baseSimulationId: {
+        string: true,
+        demandOption: true,
+        alias: "baseReplayId",
+    },
+    headSimulationId: {
+        string: true,
+        demandOption: true,
+        alias: "headReplayId",
+    },
+    threshold: common_options_1.SCREENSHOT_DIFF_OPTIONS.diffThreshold,
+    pixelThreshold: common_options_1.SCREENSHOT_DIFF_OPTIONS.diffPixelThreshold,
+})
+    .handler(handler);

package/dist/commands/serve/serve.command.d.ts

@@ -1,7 +1,10 @@
-import { CommandModule } from "yargs";
-interface Options {
-    apiToken?: string | null | undefined;
-    replayId: string;
-}
-export declare const serve: CommandModule<unknown, Options>;
-export {};
+/// <reference types="yargs" />
+export declare const serve: import("yargs").CommandModule<unknown, import("yargs").InferredOptionTypes<{
+    apiToken: {
+        string: true;
+    };
+    replayId: {
+        string: true;
+        demandOption: true;
+    };
+}>>;

package/dist/commands/serve/serve.command.js

@@ -7,25 +7,25 @@ exports.serve = void 0;
 const common_1 = require("@alwaysmeticulous/common");
 const loglevel_1 = __importDefault(require("loglevel"));
 const client_1 = require("../../api/client");
+const command_builder_1 = require("../../command-utils/command-builder");
 const serve_assets_from_simulation_1 = require("../../local-data/serve-assets-from-simulation");
-const sentry_utils_1 = require("../../utils/sentry.utils");
 const handler = async ({ apiToken, replayId, }) => {
     const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
     const client = (0, client_1.createClient)({ apiToken });
     const { url } = await (0, serve_assets_from_simulation_1.serveAssetsFromSimulation)(client, replayId);
     logger.info(`Serving assets at url ${url}`);
 };
-exports.serve = {
-    command: "serve",
+exports.serve = (0, command_builder_1.buildCommand)("serve")
+    .details({
     describe: "Spin up a localhost server to serve the assets that were snapshotted when running a particular replay",
-    builder: {
-        apiToken: {
-            string: true,
-        },
-        replayId: {
-            string: true,
-            demandOption: true,
-        },
+})
+    .options({
+    apiToken: {
+        string: true,
     },
-    handler: (0, sentry_utils_1.wrapHandler)(handler),
-};
+    replayId: {
+        string: true,
+        demandOption: true,
+    },
+})
+    .handler(handler);

package/dist/commands/show-project/show-project.command.d.ts

@@ -1,6 +1,6 @@
-import { CommandModule } from "yargs";
-interface Options {
-    apiToken?: string | null | undefined;
-}
-export declare const showProject: CommandModule<unknown, Options>;
-export {};
+/// <reference types="yargs" />
+export declare const showProject: import("yargs").CommandModule<unknown, import("yargs").InferredOptionTypes<{
+    apiToken: {
+        string: true;
+    };
+}>>;

package/dist/commands/show-project/show-project.command.js

@@ -8,7 +8,7 @@ const common_1 = require("@alwaysmeticulous/common");
 const loglevel_1 = __importDefault(require("loglevel"));
 const client_1 = require("../../api/client");
 const project_api_1 = require("../../api/project.api");
-const sentry_utils_1 = require("../../utils/sentry.utils");
+const command_builder_1 = require("../../command-utils/command-builder");
 const handler = async ({ apiToken }) => {
     const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
     const client = (0, client_1.createClient)({ apiToken });
@@ -19,13 +19,13 @@ const handler = async ({ apiToken }) => {
     }
     logger.info(project);
 };
-exports.showProject = {
-    command: "show-project",
+exports.showProject = (0, command_builder_1.buildCommand)("show-project")
+    .details({
     describe: "Shows project linked with current API token",
-    builder: {
-        apiToken: {
-            string: true,
-        },
+})
+    .options({
+    apiToken: {
+        string: true,
     },
-    handler: (0, sentry_utils_1.wrapHandler)(handler),
-};
+})
+    .handler(handler);

package/dist/commands/update-tests/update-tests.command.d.ts

@@ -1,9 +1,21 @@
-import { CommandModule } from "yargs";
-interface Options {
-    apiToken?: string | null | undefined;
-    testRunId: string;
-    accept?: string[] | null | undefined;
-    acceptAll?: boolean | null | undefined;
-}
-export declare const updateTests: CommandModule<unknown, Options>;
-export {};
+/// <reference types="yargs" />
+export declare const updateTests: import("yargs").CommandModule<unknown, import("yargs").InferredOptionTypes<{
+    apiToken: {
+        string: true;
+    };
+    testRunId: {
+        string: true;
+        demandOption: true;
+        description: string;
+    };
+    accept: {
+        string: true;
+        array: true;
+        description: string;
+    };
+    acceptAll: {
+        boolean: true;
+        description: string;
+        conflicts: string;
+    };
+}>>;

package/dist/commands/update-tests/update-tests.command.js

@@ -8,8 +8,8 @@ const common_1 = require("@alwaysmeticulous/common");
 const loglevel_1 = __importDefault(require("loglevel"));
 const client_1 = require("../../api/client");
 const test_run_api_1 = require("../../api/test-run.api");
+const command_builder_1 = require("../../command-utils/command-builder");
 const config_1 = require("../../config/config");
-const sentry_utils_1 = require("../../utils/sentry.utils");
 const handler = async ({ apiToken, testRunId, accept: accept_, acceptAll: acceptAll_, }) => {
     var _a;
     const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
@@ -69,27 +69,28 @@ const handler = async ({ apiToken, testRunId, accept: accept_, acceptAll: accept
     };
     await (0, config_1.saveConfig)(newConfig);
 };
-exports.updateTests = {
-    command: "update-tests",
+exports.updateTests = (0, command_builder_1.buildCommand)("update-tests")
+    .details({
     describe: "Updates test cases",
-    builder: {
-        apiToken: {
-            string: true,
-        },
-        testRunId: {
-            string: true,
-            demandOption: true,
-            description: "Test run id to fix",
-        },
-        accept: {
-            array: true,
-            description: "Replay ids to accept as valid",
-        },
-        acceptAll: {
-            boolean: true,
-            description: "Accept all failing tests as valid",
-            conflicts: "accept",
-        },
+})
+    .options({
+    apiToken: {
+        string: true,
     },
-    handler: (0, sentry_utils_1.wrapHandler)(handler),
-};
+    testRunId: {
+        string: true,
+        demandOption: true,
+        description: "Test run id to fix",
+    },
+    accept: {
+        string: true,
+        array: true,
+        description: "Replay ids to accept as valid",
+    },
+    acceptAll: {
+        boolean: true,
+        description: "Accept all failing tests as valid",
+        conflicts: "accept",
+    },
+})
+    .handler(handler);

package/dist/commands/upload-build/upload-build.command.d.ts

@@ -1,8 +1,13 @@
-import { CommandModule } from "yargs";
-interface Options {
-    apiToken?: string | null | undefined;
-    commitSha?: string | null | undefined;
-    dist: string;
-}
-export declare const uploadBuild: CommandModule<unknown, Options>;
-export {};
+/// <reference types="yargs" />
+export declare const uploadBuild: import("yargs").CommandModule<unknown, import("yargs").InferredOptionTypes<{
+    apiToken: {
+        string: true;
+    };
+    commitSha: {
+        string: true;
+    };
+    dist: {
+        string: true;
+        demandOption: true;
+    };
+}>>;

package/dist/commands/upload-build/upload-build.command.js

@@ -11,8 +11,8 @@ const project_build_api_1 = require("../../api/project-build.api");
 const project_api_1 = require("../../api/project.api");
 const upload_1 = require("../../api/upload");
 const archive_1 = require("../../archive/archive");
+const command_builder_1 = require("../../command-utils/command-builder");
 const commit_sha_utils_1 = require("../../utils/commit-sha.utils");
-const sentry_utils_1 = require("../../utils/sentry.utils");
 const handler = async ({ apiToken, commitSha: commitSha_, dist, }) => {
     const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
     // 1. Print project name
@@ -69,20 +69,20 @@ const handler = async ({ apiToken, commitSha: commitSha_, dist, }) => {
     logger.debug(updatedProjectBuild);
     await (0, archive_1.deleteArchive)(archivePath);
 };
-exports.uploadBuild = {
-    command: "upload-build",
+exports.uploadBuild = (0, command_builder_1.buildCommand)("upload-build")
+    .details({
     describe: "Upload build artifacts to Meticulous",
-    builder: {
-        apiToken: {
-            string: true,
-        },
-        commitSha: {
-            string: true,
-        },
-        dist: {
-            string: true,
-            demandOption: true,
-        },
+})
+    .options({
+    apiToken: {
+        string: true,
     },
-    handler: (0, sentry_utils_1.wrapHandler)(handler),
-};
+    commitSha: {
+        string: true,
+    },
+    dist: {
+        string: true,
+        demandOption: true,
+    },
+})
+    .handler(handler);