Period and newline nits

Author: jdalton

src/commands/analytics/cmd-analytics.ts

@@ -26,7 +26,7 @@ const config: CliCommandConfig = {
       shortFlag: 'f',
       default: '-',
       description:
-        'Path to a local file to save the output. Only valid with --json/--markdown. Defaults to stdout.'
+        'Filepath to save output. Only valid with --json/--markdown. Defaults to stdout.'
     },
     repo: {
       type: 'string',

src/commands/audit-log/output-audit-log.ts

@@ -100,7 +100,7 @@ export async function outputAsJson(
       'There was a problem converting the logs to JSON, please try without the `--json` flag'
     )
     if (isDebug()) {
-      debugLog('Error:', e)
+      debugLog('Error:\n', e)
     }
     return '{}'
   }
@@ -150,7 +150,7 @@ ${table}
       'There was a problem converting the logs to Markdown, please try the `--json` flag'
     )
     if (isDebug()) {
-      debugLog('Error:', e)
+      debugLog('Error:\n', e)
     }
     // logger.error(e)
     return ''

src/commands/config/discover-config-value.ts

@@ -35,7 +35,7 @@ export async function discoverConfigValue(
       success: false,
       value: undefined,
       message:
-        'When uncertain, unset this key. Otherwise ask your network administrator.'
+        'When uncertain, unset this key. Otherwise ask your network administrator'
     }
   }
 

src/commands/diff-scan/cmd-diff-scan-get.ts

@@ -101,7 +101,7 @@ async function run(
     {
       test: !!(before && after),
       message:
-        'Specify a before and after scan ID\nThe args are expecting a full `aaa0aa0a-aaaa-0000-0a0a-0000000a00a0` scan ID.',
+        'Specify a before and after scan ID.\nThe args are expecting a full `aaa0aa0a-aaaa-0000-0a0a-0000000a00a0` scan ID.',
       pass: 'ok',
       fail:
         !before && !after

src/commands/package/output-purl-score.ts

@@ -243,7 +243,7 @@ export async function outputPurlScore(
         )
       } else {
         logger.log(
-          'This package had no alerts and neither did any of its direct/transitive dependencies.'
+          'This package had no alerts and neither did any of its direct/transitive dependencies'
         )
       }
       logger.log('')

src/commands/scan/fetch-report-data.ts

@@ -82,7 +82,7 @@ export async function fetchReportData(
       )
     } else {
       spinner.successAndStop(
-        `Completed fetching ${haves.join(haves.length > 2 ? ', ' : ' and ')}.`
+        `Completed fetching ${haves.join(haves.length > 2 ? ', ' : ' and ')}`
       )
     }
   }
@@ -133,7 +133,7 @@ export async function fetchReportData(
         return data
       } catch (e) {
         spinner.errorAndStop(
-          'There was an issue while fetching full scan data.'
+          'There was an issue while fetching full scan data'
         )
         throw e
       }

src/commands/scan/suggest-org-slug.ts

@@ -38,7 +38,7 @@ export async function suggestOrgSlug(): Promise<string | void> {
     }
   } else {
     logger.fail(
-      'Failed to lookup organization list from API, unable to suggest.'
+      'Failed to lookup organization list from API, unable to suggest'
     )
   }
 }

src/commands/wrapper/check-socket-wrapper-setup.ts

@@ -12,7 +12,7 @@ export function checkSocketWrapperSetup(file: string): boolean {
 
   if (linesWithSocketAlias.length) {
     logger.log(
-      `The Socket npm/npx wrapper is set up in your bash profile (${file}).`
+      `The Socket npm/npx wrapper is set up in your bash profile (${file})`
     )
     return true
   }

src/shadow/npm/paths.ts

@@ -16,7 +16,7 @@ const { NODE_MODULES, NPM, NPX, SOCKET_CLI_ISSUES_URL } = constants
 
 function exitWithBinPathError(binName: string): never {
   logger.fail(
-    `Socket unable to locate ${binName}; ensure it is available in the PATH environment variable.`
+    `Socket unable to locate ${binName}; ensure it is available in the PATH environment variable`
   )
   // The exit code 127 indicates that the command or binary being executed
   // could not be found.

src/utils/api.ts

@@ -28,7 +28,7 @@ export function handleUnsuccessfulApiResponse<T extends SocketSdkOperations>(
 
     throw new AuthError(message)
   }
-  logger.fail(failMsgWithBadge('API returned an error', message))
+  logger.fail(failMsgWithBadge('Socket API returned an error', message))
   // eslint-disable-next-line n/no-process-exit
   process.exit(1)
 }
@@ -40,23 +40,24 @@ export async function handleApiCall<T>(
   let result: T
   try {
     result = await value
-  } catch (cause) {
-    debugLog('handleApiCall[', description, '] error:\n', cause)
-    throw new Error(`Failed ${description}`, { cause })
+  } catch (e) {
+    debugLog(`handleApiCall[${description}] error:\n`, e)
+    throw new Error(`Failed ${description}`, { cause: e })
   }
   return result
 }
 
 export async function handleApiError(code: number) {
   if (code === 400) {
-    return 'One of the options passed might be incorrect.'
-  } else if (code === 403) {
-    return 'Your API token may not have the required permissions for this command or you might be trying to access (data from) an organization that is not linked to the API key you are logged in with.'
-  } else if (code === 404) {
+    return 'One of the options passed might be incorrect'
+  }
+  if (code === 403) {
+    return 'Your API token may not have the required permissions for this command or you might be trying to access (data from) an organization that is not linked to the API key you are logged in with'
+  }
+  if (code === 404) {
     return 'The requested Socket API endpoint was not found (404) or there was no result for the requested parameters. This could be a temporary problem caused by an incident or a bug in the CLI. If the problem persists please let us know.'
-  } else {
-    return `Server responded with status code ${code}`
   }
+  return `Server responded with status code ${code}`
 }
 
 export function getLastFiveOfApiToken(token: string): string {