@argos-ci/cli 3.2.0 → 4.0.0

package/dist/index.js

@@ -11,10 +11,18 @@ import ora from "ora";
 
 // src/options.ts
 import { Option } from "commander";
-var parallelNonce = new Option(
+var parallelNonceOption = new Option(
   "--parallel-nonce <string>",
   "A unique ID for this parallel build"
 ).env("ARGOS_PARALLEL_NONCE");
+var tokenOption = new Option(
+  "--token <token>",
+  "Repository token"
+).env("ARGOS_TOKEN");
+var buildNameOption = new Option(
+  "--build-name <string>",
+  "Name of the build, in case you want to run multiple Argos builds in a single CI job"
+).env("ARGOS_BUILD_NAME");
 
 // src/commands/upload.ts
 function uploadCommand(program2) {
@@ -25,14 +33,7 @@ function uploadCommand(program2) {
   ).option(
     "-i, --ignore <patterns...>",
     'One or more globs matching image file paths to ignore (ex: "**/*.png **/diff.jpg")'
-  ).addOption(
-    new Option2("--token <token>", "Repository token").env("ARGOS_TOKEN")
-  ).addOption(
-    new Option2(
-      "--build-name <string>",
-      "Name of the build, in case you want to run multiple Argos builds in a single CI job"
-    ).env("ARGOS_BUILD_NAME")
-  ).addOption(
+  ).addOption(tokenOption).addOption(buildNameOption).addOption(
     new Option2(
       "--mode <string>",
       "Mode of comparison applied. CI for visual regression testing, monitoring for visual monitoring."
@@ -47,7 +48,7 @@ function uploadCommand(program2) {
       "--parallel-total <number>",
       "The number of parallel nodes being ran"
     ).env("ARGOS_PARALLEL_TOTAL")
-  ).addOption(parallelNonce).addOption(
+  ).addOption(parallelNonceOption).addOption(
     new Option2(
       "--parallel-index <number>",
       "The index of the parallel node being ran (must be at least 1)"
@@ -67,31 +68,38 @@ function uploadCommand(program2) {
       "--threshold <number>",
       "Sensitivity threshold between 0 and 1. The higher the threshold, the less sensitive the diff will be. Default to 0.5"
     ).env("ARGOS_THRESHOLD")
-  ).addOption(
-    new Option2(
-      "--skipped",
-      "Mark this build as skipped. No screenshots are uploaded, and the commit status is marked as success."
-    ).env("ARGOS_SKIPPED")
   ).action(async (directory, options) => {
     const spinner = ora("Uploading screenshots").start();
     try {
+      const parallel = (() => {
+        if (!options.parallel) {
+          return void 0;
+        }
+        if (!options.parallelNonce) {
+          spinner.fail("--parallel-nonce is required if --parallel is set");
+          process.exit(1);
+        }
+        if (!options.parallelTotal) {
+          spinner.fail("--parallel-total is required if --parallel is set");
+          process.exit(1);
+        }
+        return {
+          nonce: options.parallelNonce,
+          total: options.parallelTotal,
+          index: options.parallelIndex
+        };
+      })();
       const result = await upload({
         token: options.token,
         root: directory,
         buildName: options.buildName,
         files: options.files,
         ignore: options.ignore,
-        prNumber: options.pullRequest ? Number(options.pullRequest) : void 0,
-        parallel: options.parallel ? {
-          nonce: options.parallelNonce,
-          total: options.parallelTotal,
-          index: options.parallelIndex
-        } : void 0,
+        parallel,
         referenceBranch: options.referenceBranch,
         referenceCommit: options.referenceCommit,
         mode: options.mode,
-        threshold: options.threshold,
-        skipped: options.skipped
+        threshold: options.threshold
       });
       spinner.succeed(`Build created: ${result.build.url}`);
     } catch (error) {
@@ -108,13 +116,11 @@ function uploadCommand(program2) {
 import ora2 from "ora";
 import { finalize } from "@argos-ci/core";
 function finalizeCommand(program2) {
-  program2.command("finalize").description("Finalize pending parallel builds").addOption(parallelNonce).action(async (options) => {
+  program2.command("finalize").description("Finalize pending parallel builds").addOption(parallelNonceOption).action(async (options) => {
     const spinner = ora2("Finalizing builds").start();
     try {
       const result = await finalize({
-        parallel: {
-          nonce: options.parallelNonce
-        }
+        parallel: options.parallelNonce ? { nonce: options.parallelNonce } : void 0
       });
       spinner.succeed(
         result.builds.length === 0 ? "No builds to finalize" : `Builds finalized: ${result.builds.map((b) => b.url).join(", ")}`
@@ -129,6 +135,28 @@ function finalizeCommand(program2) {
   });
 }
 
+// src/commands/skip.ts
+import { skip } from "@argos-ci/core";
+import ora3 from "ora";
+function skipCommand(program2) {
+  program2.command("skip").description("Mark a build as skipped").addOption(tokenOption).addOption(buildNameOption).action(async (options) => {
+    const spinner = ora3("Creating skipped build").start();
+    try {
+      const result = await skip({
+        token: options.token,
+        buildName: options.buildName
+      });
+      spinner.succeed(`Build created: ${result.build.url}`);
+    } catch (error) {
+      if (error instanceof Error) {
+        spinner.fail(`Build failed: ${error.message}`);
+        console.error(error.stack);
+      }
+      process.exit(1);
+    }
+  });
+}
+
 // src/index.ts
 var __dirname = fileURLToPath(new URL(".", import.meta.url));
 var rawPkg = await readFile(resolve(__dirname, "..", "package.json"), "utf8");
@@ -137,6 +165,7 @@ program.name(pkg.name).description(
   "Interact with and upload screenshots to Argos via command line."
 ).version(pkg.version);
 uploadCommand(program);
+skipCommand(program);
 finalizeCommand(program);
 if (!process.argv.slice(2).length) {
   program.outputHelp();

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@argos-ci/cli",
   "description": "Command-line (CLI) for visual testing with Argos.",
-  "version": "3.2.0",
+  "version": "4.0.0",
   "bin": {
     "argos": "./bin/argos-cli.js"
   },
@@ -34,17 +34,17 @@
     "access": "public"
   },
   "dependencies": {
-    "@argos-ci/core": "4.4.0",
+    "@argos-ci/core": "5.0.0",
     "commander": "^14.0.2",
     "ora": "^9.0.0",
     "update-notifier": "^7.3.1"
   },
   "scripts": {
     "build": "tsup",
-    "e2e": "node e2e/upload.js",
+    "e2e": "node e2e/upload.js && node e2e/skip.js",
     "check-types": "tsc",
     "check-format": "prettier --check --ignore-unknown --ignore-path=../../.gitignore --ignore-path=../../.prettierignore .",
     "lint": "eslint ."
   },
-  "gitHead": "7b770d9d0c621980319bd5a195413f96c54d5752"
+  "gitHead": "d460ccc12fe75b1d9389d58647f1906bee7d5e0d"
 }

package/LICENSE

@@ -1,7 +0,0 @@
-Copyright 2022 Smooth Code
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.