Improve help output.

Author: onurtemizkan

packages/remix/scripts/upload-sourcemaps.js

@@ -1,21 +1,46 @@
 #! /usr/bin/env node
 const SentryCli = require('@sentry/cli');
-const argv = require('yargs/yargs')(process.argv.slice(2))
-  .option('release', { type: 'string', describe: 'The release number' })
-  .option('urlPrefix', { type: 'string', describe: 'The url prefix for the sourcemaps' })
-  .option('buildPath', { type: 'string', describe: 'The path to the build directory' })
+const yargs = require('yargs/yargs');
+
+const DEFAULT_URL_PREFIX = '~/build/';
+const DEFAULT_BUILD_PATH = 'public/build';
+
+const argv = yargs(process.argv.slice(2))
+  .option('release', {
+    type: 'string',
+    describe:
+      'The release number\n' +
+      "If not provided, a new release id will be determined by Sentry CLI's `propose-version`.\n" +
+      'See: https://docs.sentry.io/product/releases/suspect-commits/#using-the-cli\n',
+  })
+  .option('urlPrefix', {
+    type: 'string',
+    describe: 'URL prefix to add to the beginning of all filenames',
+    default: DEFAULT_URL_PREFIX,
+  })
+  .option('buildPath', {
+    type: 'string',
+    describe: 'The path to the build directory',
+    default: DEFAULT_BUILD_PATH,
+  })
   .usage(
-    'Usage: $0 [--release RELEASE] [--urlPrefix URL_PREFIX] [--buildPath BUILD_PATH] \n\n' +
+    'Usage: $0\n' +
+      '  [--release RELEASE]\n' +
+      '  [--urlPrefix URL_PREFIX]\n' +
+      '  [--buildPath BUILD_PATH]\n\n' +
+      'This CLI tool will upload sourcemaps to Sentry for the given release.\n' +
+      'It has defaults for URL prefix and build path for Remix builds, but you can override them.\n\n' +
       'If you need a more advanced configuration, you can use `sentry-cli` instead.\n' +
       'https://github.com/getsentry/sentry-cli',
-  ).argv;
+  )
+  .wrap(120).argv;
 
 const sentry = new SentryCli();
 
 async function createRelease() {
   const RELEASE = argv.release || (await sentry.releases.proposeVersion());
-  const URL_PREFIX = argv.urlPrefix || '~/build/';
-  const BUILD_PATH = argv.buildPath || 'public/build';
+  const URL_PREFIX = argv.urlPrefix || DEFAULT_URL_PREFIX;
+  const BUILD_PATH = argv.buildPath || DEFAULT_BUILD_PATH;
 
   await sentry.releases.new(RELEASE);