Add --no-spinner support

Author: jdalton

src/flags.mts

@@ -149,47 +149,55 @@ export const commonFlags: MeowFlags = {
   config: {
     type: 'string',
     default: '',
-    hidden: true,
     description: 'Override the local config with this JSON',
+    hidden: true,
   },
   dryRun: {
     type: 'boolean',
     default: false,
-    // Only show in root command.
-    hidden: true,
     description:
       'Do input validation for a command and exit 0 when input is ok',
+    // Only show in root command.
+    hidden: true,
   },
   help: {
     type: 'boolean',
     default: false,
     shortFlag: 'h',
-    hidden: true,
     description: 'Print this help',
+    hidden: true,
   },
   maxOldSpaceSize: {
     type: 'number',
     get default() {
       return getMaxOldSpaceSizeFlag()
     },
-    hidden: true,
     description: `Set Node's V8 ${terminalLink('--max-old-space-size', 'https://nodejs.org/api/cli.html#--max-old-space-sizesize-in-mib')} option`,
+    hidden: true,
   },
   maxSemiSpaceSize: {
     type: 'number',
     get default() {
       return getMaxSemiSpaceSizeFlag()
     },
-    hidden: true,
     description: `Set Node's V8 ${terminalLink('--max-semi-space-size', 'https://nodejs.org/api/cli.html#--max-semi-space-sizesize-in-mib')} option`,
+    hidden: true,
   },
+
+  // I know this would be `--no-banner` but that doesn't work with cdxgen.
+  // Mostly for internal usage anyways.
   nobanner: {
-    // I know this would be `--no-banner` but that doesn't work with cdxgen.
-    // Mostly for internal usage anyways.
     type: 'boolean',
     default: false,
-    hidden: true,
     description: 'Hide the Socket banner',
+    hidden: true,
+  },
+  // Hidden to allow custom documenting of the negated `--no-spinner` variant.
+  spinner: {
+    type: 'boolean',
+    default: true,
+    description: 'Hide the console spinner',
+    hidden: true,
   },
 }
 

src/utils/meow-with-subcommands.mts

@@ -7,6 +7,7 @@ import { logger } from '@socketsecurity/registry/lib/logger'
 import { hasOwn, toSortedObject } from '@socketsecurity/registry/lib/objects'
 import { normalizePath } from '@socketsecurity/registry/lib/path'
 import { naturalCompare } from '@socketsecurity/registry/lib/sorts'
+import { Spinner } from '@socketsecurity/registry/lib/spinner'
 import {
   indentString,
   trimNewlines,
@@ -24,7 +25,7 @@ import { commonFlags } from '../flags.mts'
 import { getVisibleTokenPrefix } from './sdk.mts'
 import { tildify } from './tildify.mts'
 
-import type { MeowFlags } from '../flags.mts'
+import type { MeowFlag, MeowFlags } from '../flags.mts'
 import type { Options, Result } from 'meow'
 
 export interface CliAlias {
@@ -300,8 +301,14 @@ export async function meowWithSubcommands(
     booleanDefault: undefined,
   })
 
+  const noSpinner = cli1.flags['spinner'] === false
   const orgFlag = String(cli1.flags['org'] || '') || undefined
 
+  // Use CI spinner style when --no-spinner is passed.
+  if (noSpinner) {
+    constants.spinner.spinner = Spinner.spinners['ci']!
+  }
+
   // Hard override the config if instructed to do so.
   // The env var overrides the --flag, which overrides the persisted config
   // Also, when either of these are used, config updates won't persist.
@@ -501,7 +508,17 @@ export async function meowWithSubcommands(
     lines.push('')
   }
   lines.push(
-    `  ${getFlagListOutput(flags, { indent: HELP_INDENT, padName: HELP_PAD_NAME })}`,
+    `  ${getFlagListOutput(
+      {
+        ...flags,
+        // Explicitly document the negated --no-spinner variant.
+        noSpinner: {
+          ...flags['spinner'],
+          hidden: false,
+        } as MeowFlag,
+      },
+      { indent: HELP_INDENT, padName: HELP_PAD_NAME },
+    )}`,
   )
   if (isRootCommand) {
     lines.push(
@@ -604,6 +621,13 @@ export function meowOrExit({
     importMeta,
   })
 
+  const noSpinner = cli.flags['spinner'] === false
+
+  // Use CI spinner style when --no-spinner is passed.
+  if (noSpinner) {
+    constants.spinner.spinner = Spinner.spinners['ci']!
+  }
+
   if (!shouldSuppressBanner(cli.flags)) {
     const orgFlag = String(cli.flags['org'] || '').trim() || undefined
     emitBanner(command, orgFlag)