@socketsecurity/cli-with-sentry 1.0.91 → 1.0.93

package/dist/utils.js

@@ -8,9 +8,11 @@ var arrays = require('../external/@socketsecurity/registry/lib/arrays');
 var require$$7 = require('../external/@socketsecurity/registry/lib/objects');
 var path$1 = require('../external/@socketsecurity/registry/lib/path');
 var sorts = require('../external/@socketsecurity/registry/lib/sorts');
+var words = require('../external/@socketsecurity/registry/lib/words');
+var require$$5 = require('node:module');
+var path = require('node:path');
 var constants = require('./constants.js');
 var flags = require('./flags.js');
-var path = require('node:path');
 var regexps = require('../external/@socketsecurity/registry/lib/regexps');
 var prompts = require('../external/@socketsecurity/registry/lib/prompts');
 var spawn = require('../external/@socketsecurity/registry/lib/spawn');
@@ -18,7 +20,6 @@ var fs = require('../external/@socketsecurity/registry/lib/fs');
 var fs$1 = require('node:fs');
 var registry = require('../external/@socketsecurity/registry');
 var packages = require('../external/@socketsecurity/registry/lib/packages');
-var require$$5 = require('node:module');
 var npm = require('../external/@socketsecurity/registry/lib/npm');
 var streams = require('../external/@socketsecurity/registry/lib/streams');
 var globs = require('../external/@socketsecurity/registry/lib/globs');
@@ -792,7 +793,7 @@ function serializeResultJson(data) {
     return JSON.stringify({
       ok: false,
       message: 'Unable to serialize JSON',
-      data: message
+      cause: message
     }).trim() + '\n';
   }
   try {
@@ -809,7 +810,7 @@ function serializeResultJson(data) {
     return JSON.stringify({
       ok: false,
       message: 'Unable to serialize JSON',
-      data: message
+      cause: message
     }).trim() + '\n';
   }
 }
@@ -872,9 +873,46 @@ function getOutputKind(json, markdown) {
   return 'text';
 }
 
+const require$2 = require$$5.createRequire(require('node:url').pathToFileURL(__filename).href);
+let _requirements;
+function getRequirements() {
+  if (_requirements === undefined) {
+    _requirements = /*@__PURE__*/require$2(
+    // Lazily access constants.rootPath.
+    path.join(constants.rootPath, 'requirements.json'));
+  }
+  return _requirements;
+}
+
 function camelToKebab(string) {
   return string.replace(/([a-z])([A-Z])/g, '$1-$2').toLowerCase();
 }
+function getFlagApiRequirementsOutput(cmdPath, options) {
+  const {
+    indent = 6
+  } = {
+    __proto__: null,
+    ...options
+  };
+  const key = cmdPath.replace(/^socket[: ]/, '').replace(/ +/g, ':');
+  const requirements = getRequirements();
+  const data = requirements.api[key];
+  let result = '';
+  if (data) {
+    const quota = data?.quota;
+    const perms = data?.permissions;
+    const padding = ''.padEnd(indent);
+    const lines = [];
+    if (typeof quota === 'number') {
+      lines.push(`${padding}- Quota: ${quota} ${words.pluralize('unit', quota)}`);
+    }
+    if (Array.isArray(perms) && perms.length) {
+      lines.push(`${padding}- Permissions: ${perms.join(' ')}`);
+    }
+    result += lines.join('\n');
+  }
+  return result.trim() || '(none)';
+}
 function getFlagListOutput(list, options) {
   const {
     keyPrefix = '--'
@@ -906,7 +944,7 @@ function getHelpListOutput(list, options) {
     if (entryIsObj && 'hidden' in entry && entry?.hidden) {
       continue;
     }
-    const printedName = keyPrefix + camelToKebab(name);
+    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);
@@ -935,6 +973,55 @@ function description(command) {
   const str = typeof description === 'string' ? description : String(description);
   return strings.indentString(str, HELP_PAD_NAME).trimStart();
 }
+
+/**
+ * Find the best matching command name for a typo.
+ */
+function findBestCommandMatch(input, subcommands, aliases) {
+  let bestMatch = null;
+  let bestScore = Infinity;
+  const allCommands = [...Object.keys(subcommands), ...Object.keys(aliases)];
+  for (const command of allCommands) {
+    const distance = levenshteinDistance(input.toLowerCase(), command.toLowerCase());
+    const maxLength = Math.max(input.length, command.length);
+    // Only suggest if the similarity is reasonable (more than 50% similar).
+    if (distance < maxLength * 0.5 && distance < bestScore) {
+      bestScore = distance;
+      bestMatch = command;
+    }
+  }
+  return bestMatch;
+}
+
+/**
+ * Calculate Levenshtein distance between two strings for fuzzy matching.
+ */
+function levenshteinDistance(a, b) {
+  const matrix = Array.from({
+    length: a.length + 1
+  }, () => Array(b.length + 1).fill(0));
+  for (let i = 0; i <= a.length; i++) {
+    matrix[i][0] = i;
+  }
+  for (let j = 0; j <= b.length; j++) {
+    matrix[0][j] = j;
+  }
+  for (let i = 1; i <= a.length; i++) {
+    for (let j = 1; j <= b.length; j++) {
+      const cost = a[i - 1] === b[j - 1] ? 0 : 1;
+      matrix[i][j] = Math.min(matrix[i - 1][j] + 1,
+      // Deletion.
+      matrix[i][j - 1] + 1,
+      // Insertion.
+      matrix[i - 1][j - 1] + cost // Substitution.
+      );
+    }
+  }
+  return matrix[a.length][b.length];
+}
+function shouldSuppressBanner(flags) {
+  return Boolean(flags['json'] || flags['markdown'] || flags['nobanner']);
+}
 async function meowWithSubcommands(subcommands, options) {
   const {
     aliases = {},
@@ -1061,9 +1148,11 @@ async function meowWithSubcommands(subcommands, options) {
     }
   }
   if (configOverrideResult?.ok === false) {
-    emitBanner(name, orgFlag);
-    // Add newline in stderr.
-    logger.logger.error('');
+    if (!shouldSuppressBanner(cli1.flags)) {
+      emitBanner(name, orgFlag);
+      // Add newline in stderr.
+      logger.logger.error('');
+    }
     logger.logger.fail(configOverrideResult.message);
     process.exitCode = 2;
     return;
@@ -1082,6 +1171,16 @@ async function meowWithSubcommands(subcommands, options) {
         parentName: name
       });
     }
+
+    // Suggest similar commands for typos.
+    if (commandName && !commandDefinition) {
+      const suggestion = findBestCommandMatch(commandName, subcommands, aliases);
+      if (suggestion) {
+        process.exitCode = 2;
+        logger.logger.fail(`Unknown command "${commandName}". Did you mean "${suggestion}"?`);
+        return;
+      }
+    }
   }
   const lines = ['', 'Usage', `  $ ${name} <command>`];
   if (isRootCommand) {
@@ -1090,7 +1189,7 @@ async function meowWithSubcommands(subcommands, options) {
   lines.push('');
   if (isRootCommand) {
     // "Bucket" some commands for easier usage.
-    const commands = new Set(['analytics', 'audit-log', 'ci', 'cdxgen', 'config', 'deps', 'fix', 'install',
+    const commands = new Set(['analytics', 'audit-log', 'ci', 'cdxgen', 'config', 'dependencies', 'fix', 'install',
     //'json',
     'license', 'login', 'logout', 'manifest', 'npm', 'npx', 'optimize', 'organization', 'package', 'raw-npm', 'raw-npx', 'repository', 'scan',
     //'security',
@@ -1164,7 +1263,7 @@ async function meowWithSubcommands(subcommands, options) {
   });
 
   // ...else we provide basic instructions and help.
-  if (!cli2.flags['nobanner']) {
+  if (!shouldSuppressBanner(cli2.flags)) {
     emitBanner(name, orgFlag);
     // meow will add newline so don't add stderr spacing here
   }
@@ -1205,7 +1304,7 @@ function meowOrExit({
     help: strings.trimNewlines(config.help(command, config)),
     importMeta
   });
-  if (!cli.flags['nobanner']) {
+  if (!shouldSuppressBanner(cli.flags)) {
     emitBanner(command, String(cli.flags['org'] || '') || undefined);
     // Add newline in stderr.
     // Meow help adds a newline too so we do it here.
@@ -1502,6 +1601,18 @@ async function getDefaultOrgSlug() {
   };
 }
 
+// Listed in order of check preference.
+const COMMON_DEFAULT_BRANCH_NAMES = [
+// Modern default (GitHub, GitLab, Bitbucket have switched to this).
+'main',
+// Historic default in Git (pre-2020, still used in many repos).
+'master',
+// Common in Git Flow workflows (main for stable, develop for ongoing work).
+'develop',
+// Used by teams adopting trunk-based development practices.
+'trunk',
+// Used in some older enterprise setups and tools.
+'default'];
 async function getBaseBranch(cwd = process.cwd()) {
   // Lazily access constants.ENV properties.
   const {
@@ -1534,7 +1645,7 @@ async function getBaseBranch(cwd = process.cwd()) {
 }
 async function getRepoInfo(cwd = process.cwd()) {
   let info = null;
-  const quotedCmd = 'git remote get-url origin`';
+  const quotedCmd = '`git remote get-url origin`';
   require$$6.debugFn('stdio', `spawn: ${quotedCmd}`);
   try {
     const remoteUrl = (await spawn.spawn('git', ['remote', 'get-url', 'origin'], {
@@ -1557,24 +1668,74 @@ async function getRepoInfo(cwd = process.cwd()) {
 }
 async function getRepoName(cwd = process.cwd()) {
   const repoInfo = await getRepoInfo(cwd);
-  return repoInfo?.repo ?? null;
+  // Lazily access constants.SOCKET_DEFAULT_REPOSITORY.
+  return repoInfo?.repo ?? constants.SOCKET_DEFAULT_REPOSITORY;
 }
 async function gitBranch(cwd = process.cwd()) {
   const stdioPipeOptions = {
     cwd
   };
+  let quotedCmd = '`git symbolic-ref --short HEAD`';
+  require$$6.debugFn('stdio', `spawn: ${quotedCmd}`);
   // Try symbolic-ref first which returns the branch name or fails in a
   // detached HEAD state.
   try {
-    return (await spawn.spawn('git', ['symbolic-ref', '--short', 'HEAD'], stdioPipeOptions)).stdout;
-  } catch {}
+    const gitSymbolicRefResult = await spawn.spawn('git', ['symbolic-ref', '--short', 'HEAD'], stdioPipeOptions);
+    require$$6.debugDir('stdio', {
+      gitSymbolicRefResult
+    });
+    return gitSymbolicRefResult.stdout;
+  } catch (e) {
+    if (require$$6.isDebug('stdio')) {
+      require$$6.debugFn('error', `caught: ${quotedCmd} failed`);
+      require$$6.debugDir('inspect', {
+        error: e
+      });
+    }
+  }
   // Fallback to using rev-parse to get the short commit hash in a
   // detached HEAD state.
+  quotedCmd = '`git rev-parse --short HEAD`';
+  require$$6.debugFn('stdio', `spawn: ${quotedCmd}`);
   try {
-    return (await spawn.spawn('git', ['rev-parse', '--short', 'HEAD'], stdioPipeOptions)).stdout;
-  } catch {}
+    const gitRevParseResult = await spawn.spawn('git', ['rev-parse', '--short', 'HEAD'], stdioPipeOptions);
+    require$$6.debugDir('stdio', {
+      gitRevParseResult
+    });
+    return gitRevParseResult.stdout;
+  } catch (e) {
+    if (require$$6.isDebug('stdio')) {
+      require$$6.debugFn('error', `caught: ${quotedCmd} failed`);
+      require$$6.debugDir('inspect', {
+        error: e
+      });
+    }
+  }
   return null;
 }
+
+/**
+ * Try to detect the default branch name by checking common patterns.
+ * Returns the first branch that exists in the repository.
+ */
+async function detectDefaultBranch(cwd = process.cwd()) {
+  // First pass: check all local branches
+  for (const branch of COMMON_DEFAULT_BRANCH_NAMES) {
+    // eslint-disable-next-line no-await-in-loop
+    if (await gitLocalBranchExists(branch, cwd)) {
+      return branch;
+    }
+  }
+  // Second pass: check remote branches only if no local branch found
+  for (const branch of COMMON_DEFAULT_BRANCH_NAMES) {
+    // eslint-disable-next-line no-await-in-loop
+    if (await gitRemoteBranchExists(branch, cwd)) {
+      return branch;
+    }
+  }
+  // Lazily access constants.SOCKET_DEFAULT_BRANCH.
+  return constants.SOCKET_DEFAULT_BRANCH;
+}
 async function gitCleanFdx(cwd = process.cwd()) {
   const stdioIgnoreOptions = {
     cwd,
@@ -1721,7 +1882,7 @@ async function gitEnsureIdentity(name, email, cwd = process.cwd()) {
   const stdioPipeOptions = {
     cwd
   };
-  const identEntries = [['user.email', name], ['user.name', email]];
+  const identEntries = [['user.email', email], ['user.name', name]];
   await Promise.all(identEntries.map(async ({
     0: prop,
     1: value
@@ -1732,7 +1893,11 @@ async function gitEnsureIdentity(name, email, cwd = process.cwd()) {
       require$$6.debugFn('stdio', `spawn: ${quotedCmd}`);
       try {
         // Will throw with exit code 1 if the config property is not set.
-        configValue = (await spawn.spawn('git', ['config', '--get', prop], stdioPipeOptions)).stdout;
+        const gitConfigResult = await spawn.spawn('git', ['config', '--get', prop], stdioPipeOptions);
+        require$$6.debugDir('stdio', {
+          gitConfigResult
+        });
+        configValue = gitConfigResult.stdout;
       } catch (e) {
         if (require$$6.isDebug('stdio')) {
           require$$6.debugFn('error', `caught: ${quotedCmd} failed`);
@@ -1787,9 +1952,22 @@ async function gitRemoteBranchExists(branch, cwd = process.cwd()) {
   const stdioPipeOptions = {
     cwd
   };
+  const quotedCmd = `\`git ls-remote --heads origin ${branch}\``;
+  require$$6.debugFn('stdio', `spawn: ${quotedCmd}`);
   try {
-    return (await spawn.spawn('git', ['ls-remote', '--heads', 'origin', branch], stdioPipeOptions)).stdout.length > 0;
-  } catch {}
+    const lsRemoteResult = await spawn.spawn('git', ['ls-remote', '--heads', 'origin', branch], stdioPipeOptions);
+    require$$6.debugDir('stdio', {
+      lsRemoteResult
+    });
+    return lsRemoteResult.stdout.length > 0;
+  } catch (e) {
+    if (require$$6.isDebug('stdio')) {
+      require$$6.debugFn('error', `caught: ${quotedCmd} failed`);
+      require$$6.debugDir('inspect', {
+        error: e
+      });
+    }
+  }
   return false;
 }
 async function gitResetAndClean(branch = 'HEAD', cwd = process.cwd()) {
@@ -1821,8 +1999,13 @@ async function gitUnstagedModifiedFiles(cwd = process.cwd()) {
     cwd
   };
   const quotedCmd = `\`git diff --name-only\``;
+  require$$6.debugFn('stdio', `spawn: ${quotedCmd}`);
   try {
-    const changedFilesDetails = (await spawn.spawn('git', ['diff', '--name-only'], stdioPipeOptions)).stdout;
+    const gitDiffResult = await spawn.spawn('git', ['diff', '--name-only'], stdioPipeOptions);
+    require$$6.debugDir('stdio', {
+      gitDiffResult
+    });
+    const changedFilesDetails = gitDiffResult.stdout;
     const relPaths = changedFilesDetails.split('\n');
     return {
       ok: true,
@@ -1933,7 +2116,7 @@ function extractTier1ReachabilityScanId(socketFactsFile) {
   const tier1ReachabilityScanId = String(json?.['tier1ReachabilityScanId'] ?? '').trim();
   return tier1ReachabilityScanId.length > 0 ? tier1ReachabilityScanId : undefined;
 }
-async function spawnCoana(args, options, extra) {
+async function spawnCoana(args, orgSlug, options, extra) {
   const {
     env: spawnEnv
   } = {
@@ -1948,9 +2131,13 @@ async function spawnCoana(args, options, extra) {
   if (defaultApiToken) {
     mixinsEnv['SOCKET_CLI_API_TOKEN'] = defaultApiToken;
   }
-  const orgSlugCResult = await getDefaultOrgSlug();
-  if (orgSlugCResult.ok) {
-    mixinsEnv['SOCKET_ORG_SLUG'] = orgSlugCResult.data;
+  if (orgSlug) {
+    mixinsEnv['SOCKET_ORG_SLUG'] = orgSlug;
+  } else {
+    const orgSlugCResult = await getDefaultOrgSlug();
+    if (orgSlugCResult.ok) {
+      mixinsEnv['SOCKET_ORG_SLUG'] = orgSlugCResult.data;
+    }
   }
   try {
     const output = await spawn.spawn(constants.execPath, [
@@ -3898,6 +4085,7 @@ exports.cmdFlagsToString = cmdFlagsToString;
 exports.cmdPrefixMessage = cmdPrefixMessage;
 exports.createEnum = createEnum;
 exports.detectAndValidatePackageEnvironment = detectAndValidatePackageEnvironment;
+exports.detectDefaultBranch = detectDefaultBranch;
 exports.determineOrgSlug = determineOrgSlug;
 exports.extractOverridesFromPnpmLockSrc = extractOverridesFromPnpmLockSrc;
 exports.extractTier1ReachabilityScanId = extractTier1ReachabilityScanId;
@@ -3912,6 +4100,7 @@ exports.getConfigValueOrUndef = getConfigValueOrUndef;
 exports.getCveInfoFromAlertsMap = getCveInfoFromAlertsMap;
 exports.getDefaultOrgSlug = getDefaultOrgSlug;
 exports.getEcosystemChoicesForMeow = getEcosystemChoicesForMeow;
+exports.getFlagApiRequirementsOutput = getFlagApiRequirementsOutput;
 exports.getFlagListOutput = getFlagListOutput;
 exports.getMajor = getMajor;
 exports.getMinVersion = getMinVersion;
@@ -3978,5 +4167,5 @@ exports.tildify = tildify;
 exports.updateConfigValue = updateConfigValue;
 exports.walkNestedMap = walkNestedMap;
 exports.writeSocketJson = writeSocketJson;
-//# debugId=e570c01e-2a56-4662-9be5-b12ab8e0c125
+//# debugId=68b89be0-ee10-410b-b0e6-2f5b40be33c2
 //# sourceMappingURL=utils.js.map