@sentry/cli 2.47.0 → 2.48.0

package/checksums.txt

@@ -1,10 +1,10 @@
-sentry-cli-Darwin-arm64=a7f9304278c893fb6c39f0a60bdefdb03902d355d78d978f4a5b7def264fcd9b
-sentry-cli-Darwin-universal=0cee2628fc3835e7238b6a249a59de11391dd2b6bce21eee35254e23947e7aba
-sentry-cli-Darwin-x86_64=bcf56037d5a8da58aaead346f26e9ca36cb1b05efb170f44cefdab83cc90bdef
-sentry-cli-Linux-aarch64=6e06fc74b6449a3cdf3cbffaf4347ae2dd768efff04fa43a306d9ccea4ede54c
-sentry-cli-Linux-armv7=e1d751963403568bd2cd1de3064bf72522ab782d0e6b67153655bf9ca6459ff9
-sentry-cli-Linux-i686=fe55d031baf9d182338a0f40a443018cde535371a01a02c0eef60487ec03010a
-sentry-cli-Linux-x86_64=d51a6bc0fa076dcd3d4121b9c3f21999057a1727cbc4113f07e0acf8f17afe48
-sentry-cli-Windows-aarch64.exe=6556975813e39d0dc063d589c5152b57233e6aedafdf4d36e4293a3c70a2cc2d
-sentry-cli-Windows-i686.exe=dc0df7dd659ba4c31eda0beb8c05b3f7106dd90b0f7eb5354533de4d20b042ee
-sentry-cli-Windows-x86_64.exe=4b117ad6871af32963a41f3cb3f1fa15674f2c03ca2ce89fe918cde4bfe2a979
+sentry-cli-Darwin-arm64=4055005b478b9af96d67dd63f0821c85505e4a6f08ab5a1b9b0c3941ea542a8f
+sentry-cli-Darwin-universal=583fe0f18651e219969f0a47698b522354b0ac0fb296764c67ea36850a99d39d
+sentry-cli-Darwin-x86_64=5c2707c5d965be755c0200be19e6f9ebe924b135f79201858d375adb751eee7d
+sentry-cli-Linux-aarch64=61ed4b287492919fb30bd96511169650a88c5004f31fcce5490541b8e0d4d4bf
+sentry-cli-Linux-armv7=672049db50efd2cf28d0172cea8aff670f6f16b31a0444dc471209df1c6c0578
+sentry-cli-Linux-i686=fbad1830295a11697d3c0ee9d17819bd35872bf86539d719795afb79ba4137fd
+sentry-cli-Linux-x86_64=fdb0ee7a426cdd1b1bbae35ff4835af6fa55f0647fe558c7e8705df61b279f30
+sentry-cli-Windows-aarch64.exe=37c91959e56a704264da6595357e8412d33602d764ddf0fb2cfef4a05bd872ee
+sentry-cli-Windows-i686.exe=29ae42121c757fc7d473c458dc70deb06d9288e6ec31c15db41f6af0a557f5c3
+sentry-cli-Windows-x86_64.exe=2015a5c425fe33101c1e922c79fc6440398ee7ce328053dfb06e4839abe2d497

package/js/helper.js

@@ -186,6 +186,7 @@ function mockBinaryPath(mockPath) {
  * @typedef {object} OptionSchema
  * @prop {string} param The flag of the command line option including dashes.
  * @prop {OptionType} type The value type of the command line option.
+ * @prop {string} [invertedParam] The flag of the command line option including dashes (optional).
  */
 
 /**
@@ -245,7 +246,7 @@ function serializeOptions(schema, options) {
 /**
  * Serializes the command and its options into an arguments array.
  *
- * @param {string} command The literal name of the command.
+ * @param {string[]} command The literal name of the command.
  * @param {OptionsSchema} [schema] An options schema required by the command.
  * @param {object} [options] An options object according to the schema.
  * @returns {string[]} An arguments array that can be passed via command line.
@@ -280,7 +281,11 @@ function getPath() {
  * expect(output.trim()).toBe('sentry-cli x.y.z');
  *
  * @param {string[]} args Command line arguments passed to `sentry-cli`.
- * @param {boolean} live We inherit stdio to display `sentry-cli` output directly.
+ * @param {boolean | 'rejectOnError'} live can be set to:
+ *  - `true` to inherit stdio to display `sentry-cli` output directly.
+ *  - `false` to not inherit stdio and return the output as a string.
+ *  - `'rejectOnError'` to inherit stdio and reject the promise if the command
+ *    exits with a non-zero exit code.
  * @param {boolean} silent Disable stdout for silents build (CI/Webpack Stats, ...)
  * @param {string} [configFile] Relative or absolute path to the configuration file.
  * @param {Object} [config] More configuration to pass to the CLI
@@ -321,15 +326,27 @@ async function execute(args, live, silent, configFile, config = {}) {
     ]);
     args = [...headers, ...args];
   }
+
   return new Promise((resolve, reject) => {
-    if (live === true) {
+    if (live === true || live === 'rejectOnError') {
       const output = silent ? 'ignore' : 'inherit';
       const pid = childProcess.spawn(getPath(), args, {
         env,
         // stdin, stdout, stderr
         stdio: ['ignore', output, output],
       });
-      pid.on('exit', () => {
+      pid.on('exit', (exitCode) => {
+        if (live === 'rejectOnError') {
+          if (exitCode === 0) {
+            resolve('success (live mode)');
+          }
+          reject(new Error(`Command ${args.join(' ')} failed with exit code ${exitCode}`));
+        }
+        // According to the type definition, resolving with void is not allowed.
+        // However, for backwards compatibility, we resolve void here to
+        // avoid a behaviour-breaking change.
+        // TODO (v3): Clean this up and always resolve a string (or change the type definition)
+        // @ts-expect-error - see comment above
         resolve();
       });
     } else {

package/js/releases/index.js

@@ -10,13 +10,13 @@ const DEFAULT_IGNORE = ['node_modules'];
 
 /**
  * Schema for the `upload-sourcemaps` command.
- * @type {OptionsSchema}
+ * @type {import('../helper').OptionsSchema}
  */
 const SOURCEMAPS_SCHEMA = require('./options/uploadSourcemaps');
 
 /**
  * Schema for the `deploys new` command.
- * @type {OptionsSchema}
+ * @type {import('../helper').OptionsSchema}
  */
 const DEPLOYS_SCHEMA = require('./options/deploys');
 
@@ -95,7 +95,7 @@ class Releases {
       commitFlags.push('--ignore-missing');
     }
 
-    return this.execute(['releases', 'set-commits', release].concat(commitFlags));
+    return this.execute(['releases', 'set-commits', release].concat(commitFlags), false);
   }
 
   /**
@@ -199,7 +199,10 @@ class Releases {
 
       return uploadPaths.map((path) =>
         // `execute()` is async and thus we're returning a promise here
-        this.execute(helper.prepareCommand([...args, path], SOURCEMAPS_SCHEMA, newOptions), true)
+        this.execute(
+          helper.prepareCommand([...args, path], SOURCEMAPS_SCHEMA, newOptions),
+          options.live != null ? options.live : true
+        )
       );
     });
 
@@ -255,7 +258,11 @@ class Releases {
   /**
    * See {helper.execute} docs.
    * @param {string[]} args Command line arguments passed to `sentry-cli`.
-   * @param {boolean} live We inherit stdio to display `sentry-cli` output directly.
+   * @param {boolean | 'rejectOnError'} live can be set to:
+   *  - `true` to inherit stdio to display `sentry-cli` output directly.
+   *  - `false` to not inherit stdio and return the output as a string.
+   *  - `'rejectOnError'` to inherit stdio and reject the promise if the command
+   *    exits with a non-zero exit code.
    * @returns {Promise.<string>} A promise that resolves to the standard output.
    */
   async execute(args, live) {

package/js/releases/options/deploys.js

@@ -1,3 +1,6 @@
+/**
+ * @type {import('../../helper').OptionsSchema}
+ */
 module.exports = {
   env: {
     param: '--env',

package/js/releases/options/uploadSourcemaps.js

@@ -1,3 +1,6 @@
+/**
+ * @type {import('../../helper').OptionsSchema}
+ */
 module.exports = {
   ignore: {
     param: '--ignore',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/cli",
-  "version": "2.47.0",
+  "version": "2.48.0",
   "description": "A command line utility to work with Sentry. https://docs.sentry.io/hosted/learn/cli/",
   "repository": "git://github.com/getsentry/sentry-cli.git",
   "homepage": "https://docs.sentry.io/hosted/learn/cli/",
@@ -22,22 +22,24 @@
     "which": "^2.0.2"
   },
   "devDependencies": {
+    "@types/node": "^20.10.0",
     "@vercel/nft": "^0.22.1",
     "eslint": "^7.32.0",
     "eslint-config-prettier": "^8.5.0",
     "jest": "^27.5.1",
     "npm-run-all": "^4.1.5",
-    "prettier": "2.8.8"
+    "prettier": "2.8.8",
+    "typescript": "~5.8.3"
   },
   "optionalDependencies": {
-    "@sentry/cli-darwin": "2.47.0",
-    "@sentry/cli-linux-arm": "2.47.0",
-    "@sentry/cli-linux-arm64": "2.47.0",
-    "@sentry/cli-linux-i686": "2.47.0",
-    "@sentry/cli-linux-x64": "2.47.0",
-    "@sentry/cli-win32-i686": "2.47.0",
-    "@sentry/cli-win32-x64": "2.47.0",
-    "@sentry/cli-win32-arm64": "2.47.0"
+    "@sentry/cli-darwin": "2.48.0",
+    "@sentry/cli-linux-arm": "2.48.0",
+    "@sentry/cli-linux-arm64": "2.48.0",
+    "@sentry/cli-linux-i686": "2.48.0",
+    "@sentry/cli-linux-x64": "2.48.0",
+    "@sentry/cli-win32-i686": "2.48.0",
+    "@sentry/cli-win32-x64": "2.48.0",
+    "@sentry/cli-win32-arm64": "2.48.0"
   },
   "scripts": {
     "postinstall": "node ./scripts/install.js",
@@ -49,6 +51,7 @@
     "test:watch": "jest --watch --notify",
     "test:eslint": "eslint bin/* scripts/**/*.js js/**/*.js",
     "test:prettier": "prettier --check  bin/* scripts/**/*.js js/**/*.js",
+    "check:types": "tsc --noEmit",
     "test:vercel-nft": "node scripts/test-vercel-nft.js"
   },
   "jest": {