Fix help spacing

jdalton · jdalton · commit 8d1720e5f854 · 2025-08-07T14:00:45.000-04:00
diff --git a/src/cli.mts b/src/cli.mts
@@ -85,7 +85,7 @@ void (async () => {
         }),
       )
     } else {
-      // Bump below any spinner.
+      // Add 2 newlines in stderr to bump below any spinner.
       logger.error('\n')
       logger.fail(failMsgWithBadge(errorTitle, errorMessage))
       if (errorBody) {
diff --git a/src/commands/cli.test.mts b/src/commands/cli.test.mts
@@ -13,22 +13,19 @@ describe('socket root command', async () => {
       "CLI for Socket.dev
 
         Usage
-
           $ socket <command>
           $ socket scan create --json
           $ socket package score npm lodash --markdown
 
-          (Note: All commands have their own --help)
+        Note: All commands have their own --help
 
         Main commands
-
           socket login                Setup Socket CLI with an API token and defaults
           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                   Shorthand for \`socket scan create --report --no-interactive\`
 
         Socket API
-
           analytics                   Look up analytics data
           audit-log                   Look up the audit log for an organization
           organization                Manage Socket organization account details
@@ -38,7 +35,6 @@ describe('socket root command', async () => {
           threat-feed                 [Beta] View the threat feed
 
         Local tools
-
           fix                         Update dependencies with "fixable" Socket alerts
           manifest                    Generate a dependency manifest for certain ecosystems
           npm                         Run npm with the Socket wrapper
@@ -48,7 +44,6 @@ describe('socket root command', async () => {
           raw-npx                     Run npx without the Socket wrapper
 
         CLI configuration
-
           config                      Manage Socket CLI configuration
           install                     Install Socket CLI tab completion
           login                       Socket API login and CLI setup
@@ -57,7 +52,7 @@ describe('socket root command', async () => {
           wrapper                     Enable or disable the Socket npm/npx wrapper
 
         Options
-           (Note: All commands have these flags even when not displayed in their help)
+          Note: All commands have these flags even when not displayed in their help
 
           --config                    Override the local config with this JSON
           --dry-run                   Do input validation for a command and exit 0 when input is ok
@@ -67,7 +62,6 @@ describe('socket root command', async () => {
           --version                   Print the app version
 
         Environment variables
-
           SOCKET_CLI_ACCEPT_RISKS     Accept risks of a safe-npm or safe-npx run
           SOCKET_CLI_API_TOKEN        Set the Socket API token
           SOCKET_CLI_CONFIG           A JSON stringified Socket configuration object
@@ -83,7 +77,6 @@ describe('socket root command', async () => {
           SOCKET_CLI_VIEW_ALL_RISKS   View all risks of a safe-npm or safe-npx run
 
         Environment variables for development
-
           SOCKET_CLI_API_BASE_URL     Change the base URL for all API-calls
                                       Defaults: The "apiBaseUrl" value of socket/settings local app data
                                       if present, else https://api.socket.dev/v0/
diff --git a/src/commands/config/cmd-config.test.mts b/src/commands/config/cmd-config.test.mts
@@ -17,16 +17,14 @@ describe('socket config', async () => {
         "Manage Socket CLI configuration
 
           Usage
-
             $ socket config <command>
 
           Commands
-
-            auto                Automatically discover and set the correct value config item
-            get                 Get the value of a local CLI config item
-            list                Show all local CLI config items and their values
-            set                 Update the value of a local CLI config item
-            unset               Clear the value of a local CLI config item
+            auto                        Automatically discover and set the correct value config item
+            get                         Get the value of a local CLI config item
+            list                        Show all local CLI config items and their values
+            set                         Update the value of a local CLI config item
+            unset                       Clear the value of a local CLI config item
 
           Options
 
diff --git a/src/commands/fix/cmd-fix.mts b/src/commands/fix/cmd-fix.mts
@@ -33,7 +33,7 @@ const config: CliCommandConfig = {
     autoMerge: {
       type: 'boolean',
       default: false,
-      description: `Enable auto-merge for pull requests that Socket opens.\n                          See ${terminalLink(
+      description: `Enable auto-merge for pull requests that Socket opens.\nSee ${terminalLink(
         'GitHub documentation',
         'https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-auto-merge-for-pull-requests-in-your-repository',
       )} for managing auto-merge for pull requests in your repository.`,
@@ -49,7 +49,7 @@ const config: CliCommandConfig = {
       description: `Provide a list of ${terminalLink(
         'GHSA IDs',
         'https://docs.github.com/en/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-the-github-advisory-database#about-ghsa-ids',
-      )} to compute fixes for, as either a comma separated value or as multiple flags.\n                          Use '--ghsa all' to lookup all GHSA IDs and compute fixes for them.`,
+      )} to compute fixes for, as either a comma separated value or as multiple flags.\nUse '--ghsa all' to lookup all GHSA IDs and compute fixes for them.`,
       isMultiple: true,
       hidden: true,
     },
@@ -82,24 +82,24 @@ const config: CliCommandConfig = {
       description: `Provide a list of ${terminalLink(
         'PURLs',
         'https://github.com/package-url/purl-spec?tab=readme-ov-file#purl',
-      )} to compute fixes for, as either a comma separated value or as\n                          multiple flags, instead of querying the Socket API`,
+      )} to compute fixes for, as either a comma separated value or as\nmultiple flags, instead of querying the Socket API`,
       isMultiple: true,
       shortFlag: 'p',
     },
     rangeStyle: {
       type: 'string',
       default: 'preserve',
       description: `
-                        Define how dependency version ranges are updated in package.json (default 'preserve').
-                          Available styles:
-                            * caret - Use ^ range for compatible updates (e.g. ^1.2.3)
-                            * gt - Use > to allow any newer version (e.g. >1.2.3)
-                            * gte - Use >= to allow any newer version (e.g. >=1.2.3)
-                            * lt - Use < to allow only lower versions (e.g. <1.2.3)
-                            * lte - Use <= to allow only lower versions (e.g. <=1.2.3)
-                            * pin - Use the exact version (e.g. 1.2.3)
-                            * preserve - Retain the existing version range style as-is
-                            * tilde - Use ~ range for patch/minor updates (e.g. ~1.2.3)
+Define how dependency version ranges are updated in package.json (default 'preserve').
+Available styles:
+  * caret - Use ^ range for compatible updates (e.g. ^1.2.3)
+  * gt - Use > to allow any newer version (e.g. >1.2.3)
+  * gte - Use >= to allow any newer version (e.g. >=1.2.3)
+  * lt - Use < to allow only lower versions (e.g. <1.2.3)
+  * lte - Use <= to allow only lower versions (e.g. <=1.2.3)
+  * pin - Use the exact version (e.g. 1.2.3)
+  * preserve - Retain the existing version range style as-is
+  * tilde - Use ~ range for patch/minor updates (e.g. ~1.2.3)
       `.trim(),
     },
     test: {
diff --git a/src/commands/install/cmd-install.test.mts b/src/commands/install/cmd-install.test.mts
@@ -17,12 +17,10 @@ describe('socket install', async () => {
         "Install Socket CLI tab completion
 
           Usage
-
             $ socket install <command>
 
           Commands
-
-            completion          Install bash completion for Socket CLI
+            completion                  Install bash completion for Socket CLI
 
           Options
 
diff --git a/src/commands/manifest/cmd-manifest.test.mts b/src/commands/manifest/cmd-manifest.test.mts
@@ -17,18 +17,16 @@ describe('socket manifest', async () => {
         "Generate a dependency manifest for certain ecosystems
 
           Usage
-
             $ socket manifest <command>
 
           Commands
-
-            auto                Auto-detect build and attempt to generate manifest file
-            cdxgen              Create an SBOM with CycloneDX generator (cdxgen)
-            conda               [beta] Convert a Conda environment.yml file to a python requirements.txt
-            gradle              [beta] Use Gradle to generate a manifest file (\`pom.xml\`) for a Gradle/Java/Kotlin/etc project
-            kotlin              [beta] Use Gradle to generate a manifest file (\`pom.xml\`) for a Kotlin project
-            scala               [beta] Generate a manifest file (\`pom.xml\`) from Scala's \`build.sbt\` file
-            setup               Start interactive configurator to customize default flag values for \`socket manifest\` in this dir
+            auto                        Auto-detect build and attempt to generate manifest file
+            cdxgen                      Create an SBOM with CycloneDX generator (cdxgen)
+            conda                       [beta] Convert a Conda environment.yml file to a python requirements.txt
+            gradle                      [beta] Use Gradle to generate a manifest file (\`pom.xml\`) for a Gradle/Java/Kotlin/etc project
+            kotlin                      [beta] Use Gradle to generate a manifest file (\`pom.xml\`) for a Kotlin project
+            scala                       [beta] Generate a manifest file (\`pom.xml\`) from Scala's \`build.sbt\` file
+            setup                       Start interactive configurator to customize default flag values for \`socket manifest\` in this dir
 
           Options
 
diff --git a/src/commands/organization/cmd-organization-policy.test.mts b/src/commands/organization/cmd-organization-policy.test.mts
@@ -19,12 +19,10 @@ describe('socket organization list', async () => {
         "Organization policy details
 
           Usage
-
             $ socket organization policy <command>
 
           Commands
-
-            license             Retrieve the license policy of an organization
+            license                     Retrieve the license policy of an organization
 
           Options
 
diff --git a/src/commands/organization/cmd-organization.test.mts b/src/commands/organization/cmd-organization.test.mts
@@ -19,14 +19,12 @@ describe('socket organization', async () => {
         "Manage Socket organization account details
 
           Usage
-
             $ socket organization <command>
 
           Commands
-
-            dependencies        Search for any dependency that is being used in your organization
-            list                List organizations associated with the Socket API token
-            policy              Organization policy details
+            dependencies                Search for any dependency that is being used in your organization
+            list                        List organizations associated with the Socket API token
+            policy                      Organization policy details
 
           Options
 
diff --git a/src/commands/package/cmd-package.test.mts b/src/commands/package/cmd-package.test.mts
@@ -17,13 +17,11 @@ describe('socket package', async () => {
         "Look up published package details
 
           Usage
-
             $ socket package <command>
 
           Commands
-
-            score               Look up score for one package which reflects all of its transitive dependencies as well
-            shallow             Look up info regarding one or more packages but not their transitives
+            score                       Look up score for one package which reflects all of its transitive dependencies as well
+            shallow                     Look up info regarding one or more packages but not their transitives
 
           Options
 
diff --git a/src/commands/repository/cmd-repository.test.mts b/src/commands/repository/cmd-repository.test.mts
@@ -17,16 +17,14 @@ describe('socket repository', async () => {
         "Manage registered repositories
 
           Usage
-
             $ socket repository <command>
 
           Commands
-
-            create              Create a repository in an organization
-            del                 Delete a repository in an organization
-            list                List repositories in an organization
-            update              Update a repository in an organization
-            view                View repositories in an organization
+            create                      Create a repository in an organization
+            del                         Delete a repository in an organization
+            list                        List repositories in an organization
+            update                      Update a repository in an organization
+            view                        View repositories in an organization
 
           Options
 
diff --git a/src/commands/scan/cmd-scan.test.mts b/src/commands/scan/cmd-scan.test.mts
@@ -19,19 +19,17 @@ describe('socket scan', async () => {
         "Manage Socket scans
 
           Usage
-
             $ socket scan <command>
 
           Commands
-
-            create              Create a new Socket scan and report
-            del                 Delete a scan
-            diff                See what changed between two Scans
-            list                List the scans for an organization
-            metadata            Get a scan's metadata
-            report              Check whether a scan result passes the organizational policies (security, license)
-            setup               Start interactive configurator to customize default flag values for \`socket scan\` in this dir
-            view                View the raw results of a scan
+            create                      Create a new Socket scan and report
+            del                         Delete a scan
+            diff                        See what changed between two Scans
+            list                        List the scans for an organization
+            metadata                    Get a scan's metadata
+            report                      Check whether a scan result passes the organizational policies (security, license)
+            setup                       Start interactive configurator to customize default flag values for \`socket scan\` in this dir
+            view                        View the raw results of a scan
 
           Options
 
diff --git a/src/commands/uninstall/cmd-uninstall.test.mts b/src/commands/uninstall/cmd-uninstall.test.mts
@@ -17,12 +17,10 @@ describe('socket uninstall', async () => {
         "Uninstall Socket CLI tab completion
 
           Usage
-
             $ socket uninstall <command>
 
           Commands
-
-            completion          Uninstall bash completion for Socket CLI
+            completion                  Uninstall bash completion for Socket CLI
 
           Options
 
diff --git a/src/utils/determine-org-slug.mts b/src/utils/determine-org-slug.mts
@@ -51,7 +51,8 @@ export async function determineOrgSlug(
     logger.info(
       'Note: you can run `socket login` to set a default org. You can also override it with the --org flag.',
     )
-    logger.error('') // spacing in stderr
+    // Add newline in stderr.
+    logger.error('')
     if (dryRun) {
       logger.fail('Skipping auto-discovery of org in dry-run mode')
     } else {
diff --git a/src/utils/meow-with-subcommands.mts b/src/utils/meow-with-subcommands.mts
diff --git a/src/utils/output-formatting.mts b/src/utils/output-formatting.mts

Original file line number	Diff line number	Diff line change
`@@ -85,7 +85,7 @@ void (async () => {`
`85`	`85`	`}),`
`86`	`86`	`)`
`87`	`87`	`} else {`
`88`		`- // Bump below any spinner.`
	`88`	`+ // Add 2 newlines in stderr to bump below any spinner.`
`89`	`89`	`logger.error('\n')`
`90`	`90`	`logger.fail(failMsgWithBadge(errorTitle, errorMessage))`
`91`	`91`	`if (errorBody) {`