Merge branch 'main' into exit_report

Author: jdalton

src/cli.ts

@@ -6,6 +6,7 @@ import { pathToFileURL } from 'node:url'
 import { messageWithCauses, stackWithCauses } from 'pony-cause'
 import updateNotifier from 'tiny-updater'
 
+import { debugLog } from '@socketsecurity/registry/lib/debug'
 import { logger } from '@socketsecurity/registry/lib/logger'
 
 import { cmdAnalytics } from './commands/analytics/cmd-analytics'
@@ -107,9 +108,10 @@ void (async () => {
     } else {
       errorTitle = 'Unexpected error with no details'
     }
+    logger.error('\n') // Any-spinner-newline
     logger.fail(failMsgWithBadge(errorTitle, errorMessage))
     if (errorBody) {
-      logger.error(`\n${errorBody}`)
+      debugLog(`${errorBody}`)
     }
     await captureException(e)
   }

src/commands/info/cmd-info.test.ts

@@ -23,6 +23,8 @@ describe('socket info', async () => {
           Usage
             $ socket info <name>
 
+          Note: this command will be deprecated in favor of \`socket package score\` soon
+
           Options
             --all             Include all issues
             --dryRun          Do input validation for a command and exit 0 when input is ok

src/commands/info/cmd-info.ts

@@ -24,6 +24,8 @@ const config: CliCommandConfig = {
     Usage
       $ ${command} <name>
 
+    Note: this command will be deprecated in favor of \`socket package score\` soon
+
     Options
       ${getFlagListOutput(config.flags, 6)}
 

src/commands/package/cmd-package-score.test.ts

@@ -18,7 +18,7 @@ describe('socket package score', async () => {
       const { code, stderr, stdout } = await invokeNpm(entryPath, cmd)
       expect(stdout).toMatchInlineSnapshot(
         `
-        "Look up score for one package which reflects all of its transitive dependencies as well
+        "[beta] Look up score for one package which reflects all of its transitive dependencies as well
 
           Usage
             $ socket package score <<ecosystem> <name> | <purl>>

src/commands/package/cmd-package-score.ts

@@ -16,8 +16,8 @@ const { DRY_RUN_BAIL_TEXT } = constants
 const config: CliCommandConfig = {
   commandName: 'score',
   description:
-    'Look up score for one package which reflects all of its transitive dependencies as well',
-  hidden: true,
+    '[beta] Look up score for one package which reflects all of its transitive dependencies as well',
+  hidden: false,
   flags: {
     ...commonFlags,
     ...outputFlags

src/commands/package/cmd-package-shallow.test.ts

@@ -18,7 +18,7 @@ describe('socket package shallow', async () => {
       const { code, stderr, stdout } = await invokeNpm(entryPath, cmd)
       expect(stdout).toMatchInlineSnapshot(
         `
-        "Look up info regarding one or more packages but not their transitives
+        "[beta] Look up info regarding one or more packages but not their transitives
 
           Usage
             $ socket package shallow <<ecosystem> <name> [<name> ...] | <purl> [<purl> ...]>

src/commands/package/cmd-package-shallow.ts

@@ -15,8 +15,8 @@ const { DRY_RUN_BAIL_TEXT } = constants
 const config: CliCommandConfig = {
   commandName: 'shallow',
   description:
-    'Look up info regarding one or more packages but not their transitives',
-  hidden: true,
+    '[beta] Look up info regarding one or more packages but not their transitives',
+  hidden: false,
   flags: {
     ...commonFlags,
     ...outputFlags

src/commands/package/cmd-package.test.ts

@@ -24,7 +24,8 @@ describe('socket package', async () => {
             $ socket package <command>
 
           Commands
-            (none)
+            score             [beta] Look up score for one package which reflects all of its transitive dependencies as well
+            shallow           [beta] Look up info regarding one or more packages but not their transitives
 
           Options
             --dryRun          Do input validation for a command and exit 0 when input is ok

src/commands/package/cmd-package.ts

@@ -8,7 +8,7 @@ const description = 'Commands relating to looking up published packages'
 
 export const cmdPackage: CliSubcommand = {
   description,
-  hidden: true, // [beta]
+  hidden: false,
   async run(argv, importMeta, { parentName }) {
     await meowWithSubcommands(
       {

src/commands/scan/cmd-scan-create.ts

@@ -161,24 +161,28 @@ async function run(
   })
 
   const {
+    branch: branchName = '',
     cwd: cwdOverride,
     defaultBranch,
     dryRun,
     json,
     markdown,
     pendingHead,
     readOnly,
+    repo: repoName = '',
     report,
     tmp
   } = cli.flags as {
+    branch: string
     cwd: string
+    defaultBranch: boolean
     dryRun: boolean
-    report: boolean
     json: boolean
     markdown: boolean
-    defaultBranch: boolean
     pendingHead: boolean
     readOnly: boolean
+    repo: string
+    report: boolean
     tmp: boolean
   }
   const defaultOrgSlug = getConfigValue('defaultOrg')
@@ -189,10 +193,6 @@ async function run(
     cwdOverride && cwdOverride !== 'process.cwd()'
       ? String(cwdOverride)
       : process.cwd()
-  const { branch: branchName = '', repo: repoName = '' } = cli.flags as {
-    branch: string
-    repo: string
-  }
 
   // We're going to need an api token to suggest data because those suggestions
   // must come from data we already know. Don't error on missing api token yet.