@socketsecurity/cli-with-sentry 1.0.85 → 1.0.87

package/dist/utils.js

@@ -815,6 +815,9 @@ function getOutputKind(json, markdown) {
   return 'text';
 }
 
+function camelToKebab(string) {
+  return string.replace(/([a-z])([A-Z])/g, '$1-$2').toLowerCase();
+}
 function getFlagListOutput(list, options) {
   const {
     keyPrefix = '--'
@@ -833,7 +836,7 @@ function getHelpListOutput(list, options) {
   const {
     indent = 6,
     keyPrefix = '',
-    padName = 18
+    padName = 20
   } = {
     __proto__: null,
     ...options
@@ -842,11 +845,18 @@ function getHelpListOutput(list, options) {
   const names = Object.keys(list).sort(sorts.naturalCompare);
   for (const name of names) {
     const entry = list[name];
-    if (entry && 'hidden' in entry && entry?.hidden) {
+    const entryIsObj = require$$7.isObject(entry);
+    if (entryIsObj && 'hidden' in entry && entry?.hidden) {
       continue;
     }
-    const description = (require$$7.isObject(entry) ? entry.description : entry) || '';
-    result += ''.padEnd(indent) + (keyPrefix + name).padEnd(padName) + description + '\n';
+    const printedName = keyPrefix + camelToKebab(name);
+    const preDescription = `${''.padEnd(indent)}${printedName.padEnd(Math.max(printedName.length + 2, padName))}`;
+    result += preDescription;
+    const description = entryIsObj ? entry.description : String(entry);
+    if (description) {
+      result += strings.indentString(description, preDescription.length).trimStart();
+    }
+    result += '\n';
   }
   return result.trim() || '(none)';
 }
@@ -857,6 +867,20 @@ function tildify(cwd) {
   return cwd.replace(new RegExp(`^${regexps.escapeRegExp(constants.homePath)}(?:${path.sep}|$)`, 'i'), '~/');
 }
 
+// Property names are picked such that the name is at the top when the props
+// get ordered by alphabet while flags is near the bottom and the help text
+// at the bottom, because they tend ot occupy the most lines of code.
+
+const HELP_INDENT = 2;
+const HELP_PAD_NAME = 28;
+function description(command) {
+  const description = command?.description;
+  const str = typeof description === 'string' ? description : String(description);
+  return strings.indentString(str, HELP_PAD_NAME).trimStart();
+}
+function trimNewlines(str) {
+  return str.replace(/^\n+|\n+$/g, '');
+}
 async function meowWithSubcommands(subcommands, options) {
   const {
     aliases = {},
@@ -890,16 +914,16 @@ async function meowWithSubcommands(subcommands, options) {
   // Try to support `socket <purl>` as a shorthand for `socket package score <purl>`
   if (!isRootCommand) {
     if (commandOrAliasName?.startsWith('pkg:')) {
-      logger.logger.info('Note: Invoking `socket package score` now...');
+      logger.logger.info('Invoking `socket package score`.');
       return await meowWithSubcommands(subcommands, {
         ...options,
         argv: ['package', 'deep', ...argv]
       });
     }
-    // Support `socket npm/babel` or whatever as a shorthand, too.
+    // Support `socket npm/lodash` or whatever as a shorthand, too.
     // Accept any ecosystem and let the remote sort it out.
     if (/^[a-z]+\//.test(commandOrAliasName || '')) {
-      logger.logger.info('Note: Invoking `socket package score` now...');
+      logger.logger.info('Invoking `socket package score`.');
       return await meowWithSubcommands(subcommands, {
         ...options,
         argv: ['package', 'deep', `pkg:${commandOrAliasName}`, ...rawCommandArgv]
@@ -908,28 +932,28 @@ async function meowWithSubcommands(subcommands, options) {
   }
   if (isRootCommand) {
     flags$1['help'] = {
-      type: 'boolean',
-      hidden: false,
-      // Only show on root
-      description: 'Give you detailed help information about any sub-command'
+      ...flags$1['help'],
+      hidden: false
     };
     flags$1['config'] = {
-      type: 'string',
-      hidden: false,
-      // Only show on root
-      description: 'Allows you to temp overrides the internal CLI config'
+      ...flags$1['config'],
+      hidden: false
     };
     flags$1['dryRun'] = {
-      type: 'boolean',
-      hidden: false,
-      // Only show on root
-      description: 'Do input validation for a sub-command and then exit'
+      ...flags$1['dryRun'],
+      hidden: false
+    };
+    flags$1['maxOldSpaceSize'] = {
+      ...flags$1['maxOldSpaceSize'],
+      hidden: false
+    };
+    flags$1['maxSemiSpaceSize'] = {
+      ...flags$1['maxSemiSpaceSize'],
+      hidden: false
     };
     flags$1['version'] = {
-      type: 'boolean',
-      hidden: false,
-      // Only show on root
-      description: 'Show version of CLI'
+      ...flags$1['version'],
+      hidden: false
     };
     delete flags$1['json'];
     delete flags$1['markdown'];
@@ -939,20 +963,19 @@ async function meowWithSubcommands(subcommands, options) {
   }
 
   // This is basically a dry-run parse of cli args and flags. We use this to
-  // determine config overrides and expected output mode.
-  const cli1 = vendor.meow(`(this should never be printed)`, {
+  // determine config overrides and expected o mode.
+  const cli1 = vendor.meow({
     argv,
     importMeta,
     ...additionalOptions,
     flags: flags$1,
-    // Do not strictly check for flags here.
+    // Ensure we don't check unknown flags.
     allowUnknownFlags: true,
-    booleanDefault: undefined,
-    // We want to detect whether a bool flag is given at all.
-    // We will emit help when we're ready
-    // Plus, if we allow this then meow() can just exit here.
+    // Prevent meow from potentially exiting early.
     autoHelp: false,
-    autoVersion: false
+    autoVersion: false,
+    // We want to detect whether a bool flag is given at all.
+    booleanDefault: undefined
   });
   const orgFlag = String(cli1.flags['org'] || '') || undefined;
 
@@ -985,13 +1008,14 @@ async function meowWithSubcommands(subcommands, options) {
   }
   if (configOverrideResult?.ok === false) {
     emitBanner(name, orgFlag);
-    logger.logger.error(''); // spacing in stderr
+    // Add newline in stderr.
+    logger.logger.error('');
     logger.logger.fail(configOverrideResult.message);
     process.exitCode = 2;
     return;
   }
 
-  // If we got at least some args, then lets find out if we can find a command.
+  // If we got at least some args, then lets find o if we can find a command.
   if (commandOrAliasName) {
     const alias = aliases[commandOrAliasName];
     // First: Resolve argv data from alias if its an alias that's been given.
@@ -1005,27 +1029,18 @@ async function meowWithSubcommands(subcommands, options) {
       });
     }
   }
-  function formatCommandsForHelp(isRootCommand) {
-    if (!isRootCommand) {
-      return getHelpListOutput({
-        ...require$$7.toSortedObject(Object.fromEntries(Object.entries(subcommands).filter(({
-          1: subcommand
-        }) => !subcommand.hidden))),
-        ...require$$7.toSortedObject(Object.fromEntries(Object.entries(aliases).filter(({
-          1: alias
-        }) => {
-          const {
-            hidden
-          } = alias;
-          const cmdName = hidden ? '' : alias.argv[0];
-          const subcommand = cmdName ? subcommands[cmdName] : undefined;
-          return subcommand && !subcommand.hidden;
-        })))
-      });
-    }
-
+  const lines = ['', 'Usage', `  $ ${name} <command>`];
+  if (isRootCommand) {
+    lines.push(`  $ ${name} scan create --json`, `  $ ${name} package score npm lodash --markdown`);
+  }
+  lines.push('');
+  if (isRootCommand) {
     // "Bucket" some commands for easier usage.
-    const commands = new Set(['analytics', 'audit-log', 'config', 'fix', 'install', 'login', 'logout', 'manifest', 'npm', 'npx', 'optimize', 'organization', 'package', 'raw-npm', 'raw-npx', 'repos', 'scan', 'threat-feed', 'uninstall', 'wrapper']);
+    const commands = new Set(['analytics', 'audit-log', 'ci', 'cdxgen', 'config', 'deps', 'fix', 'install',
+    //'json',
+    'license', 'login', 'logout', 'manifest', 'npm', 'npx', 'optimize', 'organization', 'package', 'raw-npm', 'raw-npx', 'repository', 'scan',
+    //'security',
+    'threat-feed', 'uninstall', 'wrapper']);
     Object.entries(subcommands).filter(([_name, subcommand]) => !subcommand.hidden).map(([name]) => name).forEach(name => {
       if (commands.has(name)) {
         commands.delete(name);
@@ -1039,64 +1054,46 @@ async function meowWithSubcommands(subcommands, options) {
       // test snapshots we use joinAnd.
       arrays.joinAnd(Array.from(commands).sort(sorts.naturalCompare).map(c => `'${c}'`)));
     }
-    const out = [];
-    out.push('All commands have their own --help page');
-    out.push('');
-    out.push('    Main commands');
-    out.push('');
-    out.push('      socket login              Setup the Socket CLI with an API token and defaults');
-    out.push('      socket scan create        Create a new Scan and report');
-    out.push('      socket npm/eslint@1.0.0   Request the security score of a particular package');
-    out.push('      socket ci                 Shorthand for CI; socket scan create --report --no-interactive');
-    out.push('');
-    out.push('    Socket API');
-    out.push('');
-    out.push('      analytics                 Look up analytics data');
-    out.push('      audit-log                 Look up the audit log for an organization');
-    out.push('      organization              Manage organization account details');
-    out.push('      package                   Look up published package details');
-    out.push('      repository                Manage registered repositories');
-    out.push('      scan                      Manage Socket scans');
-    out.push('      threat-feed               [beta] View the threat feed');
-    out.push('');
-    out.push('    Local tools');
-    out.push('');
-    out.push('      fix                       Update dependencies with "fixable" Socket alerts');
-    out.push('      manifest                  Generate a dependency manifest for certain languages');
-    out.push('      npm                       npm wrapper functionality');
-    out.push('      npx                       npx wrapper functionality');
-    out.push('      optimize                  Optimize dependencies with @socketregistry overrides');
-    out.push('      raw-npm                   Temporarily disable the Socket npm wrapper');
-    out.push('      raw-npx                   Temporarily disable the Socket npx wrapper');
-    out.push('');
-    out.push('    CLI configuration');
-    out.push('');
-    out.push('      config                    Manage the CLI configuration directly');
-    out.push('      install                   Manually install CLI tab completion on your system');
-    out.push('      login                     Socket API login and CLI setup');
-    out.push('      logout                    Socket API logout');
-    out.push('      uninstall                 Remove the CLI tab completion from your system');
-    out.push('      wrapper                   Enable or disable the Socket npm/npx wrapper');
-    return out.join('\n');
+    lines.push('Note: All commands have their own --help', '', 'Main commands', `  socket login                ${description(subcommands['login'])}`, `  socket scan create          Create a new Socket scan and report`, `  socket npm/lodash@4.17.21   Request the Socket score of a package`, `  socket ci                   ${description(subcommands['ci'])}`, ``, 'Socket API', `  analytics                   ${description(subcommands['analytics'])}`, `  audit-log                   ${description(subcommands['audit-log'])}`, `  organization                ${description(subcommands['organization'])}`, `  package                     ${description(subcommands['package'])}`, `  repository                  ${description(subcommands['repository'])}`, `  scan                        ${description(subcommands['scan'])}`, `  threat-feed                 ${description(subcommands['threat-feed'])}`, ``, 'Local tools', `  fix                         ${description(subcommands['fix'])}`, `  manifest                    ${description(subcommands['manifest'])}`, `  npm                         ${description(subcommands['npm'])}`, `  npx                         ${description(subcommands['npx'])}`, `  optimize                    ${description(subcommands['optimize'])}`, `  raw-npm                     ${description(subcommands['raw-npm'])}`, `  raw-npx                     ${description(subcommands['raw-npx'])}`, '', 'CLI configuration', `  config                      ${description(subcommands['config'])}`, `  install                     ${description(subcommands['install'])}`, `  login                       Socket API login and CLI setup`, `  logout                      ${description(subcommands['logout'])}`, `  uninstall                   ${description(subcommands['uninstall'])}`, `  wrapper                     ${description(subcommands['wrapper'])}`);
+  } else {
+    lines.push('Commands');
+    lines.push(`  ${getHelpListOutput({
+      ...require$$7.toSortedObject(Object.fromEntries(Object.entries(subcommands).filter(({
+        1: subcommand
+      }) => !subcommand.hidden))),
+      ...require$$7.toSortedObject(Object.fromEntries(Object.entries(aliases).filter(({
+        1: alias
+      }) => {
+        const {
+          hidden
+        } = alias;
+        const cmdName = hidden ? '' : alias.argv[0];
+        const subcommand = cmdName ? subcommands[cmdName] : undefined;
+        return subcommand && !subcommand.hidden;
+      })))
+    }, {
+      indent: HELP_INDENT,
+      padName: HELP_PAD_NAME
+    })}`);
+  }
+  lines.push('', 'Options');
+  if (isRootCommand) {
+    lines.push('  Note: All commands have these flags even when not displayed in their help', '');
+  } else {
+    lines.push('');
+  }
+  lines.push(`  ${getFlagListOutput(flags$1, {
+    indent: HELP_INDENT,
+    padName: HELP_PAD_NAME
+  })}`);
+  if (isRootCommand) {
+    lines.push('', 'Environment variables', '  SOCKET_CLI_API_TOKEN        Set the Socket API token', '  SOCKET_CLI_CONFIG           A JSON stringified Socket configuration object', '  SOCKET_CLI_GIT_USER_EMAIL   The git config `user.email` used by Socket CLI', `                              ${vendor.yoctocolorsCjsExports.italic('Defaults:')} github-actions[bot]@users.noreply.github.com`, '  SOCKET_CLI_GIT_USER_NAME    The git config `user.name` used by Socket CLI', `                              ${vendor.yoctocolorsCjsExports.italic('Defaults:')} github-actions[bot]`, `  SOCKET_CLI_GITHUB_TOKEN     A classic or fine-grained ${vendor.terminalLinkExports('GitHub personal access token', 'https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens')}`, `                              ${vendor.yoctocolorsCjsExports.italic('Aliases:')} GITHUB_TOKEN`, '  SOCKET_CLI_NO_API_TOKEN     Make the default API token `undefined`', '  SOCKET_CLI_NPM_PATH         The absolute location of the npm directory', '  SOCKET_CLI_ORG_SLUG         Specify the Socket organization slug', '', '  SOCKET_CLI_ACCEPT_RISKS     Accept risks of a Socket wrapped npm/npx run', '  SOCKET_CLI_VIEW_ALL_RISKS   View all risks of a Socket wrapped npm/npx run', '', 'Environment variables for development', '  SOCKET_CLI_API_BASE_URL     Change the base URL for all API-calls', `                              ${vendor.yoctocolorsCjsExports.italic('Defaults:')} The "apiBaseUrl" value of socket/settings local app data`, '                              if present, else https://api.socket.dev/v0/', '  SOCKET_CLI_API_PROXY        Set the proxy all requests are routed through, e.g. if set to', `                              ${vendor.terminalLinkExports('http://127.0.0.1:9090', 'https://docs.proxyman.io/troubleshooting/couldnt-see-any-requests-from-3rd-party-network-libraries')} then all request are passed through that proxy`, `                              ${vendor.yoctocolorsCjsExports.italic('Aliases:')} HTTPS_PROXY, https_proxy, HTTP_PROXY, and http_proxy`, '  SOCKET_CLI_DEBUG            Enable debug logging in Socket CLI', `  DEBUG                       Enable debug logging based on the ${vendor.terminalLinkExports('debug', 'https://socket.dev/npm/package/debug')} package`);
   }
 
   // Parse it again. Config overrides should now be applied (may affect help).
   // Note: this is displayed as help screen if the command does not override it
   //       (which is the case for most sub-commands with sub-commands)
-  const cli2 = vendor.meow(`
-    Usage
-      $ ${name} <command>
-${isRootCommand ? '' : '\n    Commands'}
-      ${formatCommandsForHelp(isRootCommand)}
-
-${isRootCommand ? '    Options' : '    Options'}${isRootCommand ? '       (Note: all CLI commands have these flags even when not displayed in their help)\n' : ''}
-      ${getFlagListOutput(flags$1, {
-    padName: 25
-  })}
-
-    Examples
-      $ ${name} --help
-${isRootCommand ? `      $ ${name} scan create --json` : ''}${isRootCommand ? `\n      $ ${name} package score npm left-pad --markdown` : ''}`, {
+  const cli2 = vendor.meow({
     argv,
     importMeta,
     ...additionalOptions,
@@ -1104,11 +1101,12 @@ ${isRootCommand ? `      $ ${name} scan create --json` : ''}${isRootCommand ? `\
     // Do not strictly check for flags here.
     allowUnknownFlags: true,
     // We will emit help when we're ready.
-    // Plus, if we allow this then meow() can just exit here.
+    // Plus, if we allow this then meow may exit here.
     autoHelp: false,
     autoVersion: false,
     // We want to detect whether a bool flag is given at all.
-    booleanDefault: undefined
+    booleanDefault: undefined,
+    help: lines.map(l => strings.indentString(l, HELP_INDENT)).join('\n')
   });
 
   // ...else we provide basic instructions and help.
@@ -1142,20 +1140,21 @@ function meowOrExit({
   // This exits if .printHelp() is called either by meow itself or by us.
   const cli = vendor.meow({
     argv,
+    // Prevent meow from potentially exiting early.
     autoHelp: false,
-    // meow will exit(0) before printing the banner.
     autoVersion: false,
-    booleanDefault: undefined,
     // We want to detect whether a bool flag is given at all.
+    booleanDefault: undefined,
     collectUnknownFlags: true,
     description: config.description,
     flags: config.flags,
-    help: config.help(command, config),
+    help: trimNewlines(config.help(command, config)),
     importMeta
   });
   if (!cli.flags['nobanner']) {
     emitBanner(command, String(cli.flags['org'] || '') || undefined);
-    // Add spacing in stderr. meow.help adds a newline too so we do it here
+    // Add newline in stderr.
+    // Meow help adds a newline too so we do it here.
     logger.logger.error('');
   }
 
@@ -1167,11 +1166,12 @@ function meowOrExit({
   //   meow({
   //     argv,
   //     allowUnknownFlags: false,
+  //     // Prevent meow from potentially exiting early.
   //     autoHelp: false,
   //     autoVersion: false,
   //     description: config.description,
   //     flags: config.flags,
-  //     help: config.help(command, config),
+  //     help: trimNewlines(config.help(command, config)),
   //     importMeta,
   //   })
   // }
@@ -1198,10 +1198,11 @@ function meowOrExit({
     // As per https://github.com/sindresorhus/meow/issues/178
     // Setting `allowUnknownFlags: false` makes it reject camel cased flags.
     allowUnknownFlags: Boolean(allowUnknownFlags),
+    // Prevent meow from potentially exiting early.
     autoHelp: false,
     autoVersion: false,
     description: config.description,
-    help: config.help(command, config),
+    help: trimNewlines(config.help(command, config)),
     importMeta,
     flags: config.flags
   });
@@ -1246,7 +1247,8 @@ function getAsciiHeader(command, orgFlag) {
   |__   | ${readOnlyConfig} |  _| '_| -_|  _|     | Node: ${nodeVersion}, API token: ${shownToken}, ${orgPart}
   |_____|___|___|_,_|___|_|.dev   | Command: \`${command}\`, cwd: ${relCwd}
   `.trim();
-  return `   ${body}`; // Note: logger will auto-append a newline
+  // Note: logger will auto-append a newline.
+  return `   ${body}`;
 }
 
 function msAtHome(isoTimeStamp) {
@@ -1383,7 +1385,8 @@ async function determineOrgSlug(orgFlag, interactive, dryRun) {
     // ask from server
     logger.logger.warn('Unable to determine the target org. Trying to auto-discover it now...');
     logger.logger.info('Note: you can run `socket login` to set a default org. You can also override it with the --org flag.');
-    logger.logger.error(''); // spacing in stderr
+    // Add newline in stderr.
+    logger.logger.error('');
     if (dryRun) {
       logger.logger.fail('Skipping auto-discovery of org in dry-run mode');
     } else {
@@ -1400,7 +1403,7 @@ async function determineOrgSlug(orgFlag, interactive, dryRun) {
 async function getDefaultOrgSlug() {
   const defaultOrgResult = getConfigValueOrUndef('defaultOrg');
   if (defaultOrgResult) {
-    require$$6.debugFn('notice', 'use: org from defaultOrg value of socket/settings local app data', defaultOrgResult);
+    require$$6.debugFn('notice', 'use: org from "defaultOrg" value of socket/settings local app data', defaultOrgResult);
     return {
       ok: true,
       data: defaultOrgResult
@@ -1439,7 +1442,7 @@ async function getDefaultOrgSlug() {
       data: `Cannot determine the default organization for the API token. Unable to continue.`
     };
   }
-  require$$6.debugFn('notice', 'resolve: org from API', slug);
+  require$$6.debugFn('notice', 'resolve: org from Socket API', slug);
   return {
     ok: true,
     message: 'Retrieved default org from server',
@@ -3876,5 +3879,5 @@ exports.tildify = tildify;
 exports.updateConfigValue = updateConfigValue;
 exports.walkNestedMap = walkNestedMap;
 exports.writeSocketJson = writeSocketJson;
-//# debugId=dfdc9cb2-5681-41ae-9239-11bdfca96583
+//# debugId=619636e9-83fa-428e-adf6-5923dee8d39b
 //# sourceMappingURL=utils.js.map