Use stripIndents to help format error messages and template strings

Author: jdalton

.dep-stats.json

@@ -16,6 +16,7 @@
     "browserslist": "4.24.4",
     "chalk-table": "^1.0.2",
     "cmd-shim": "^7.0.0",
+    "common-tags": "^1.8.2",
     "hpagent": "^1.2.0",
     "ignore": "^7.0.3",
     "meow": "^13.2.0",
@@ -77,6 +78,7 @@
     "browserslist": "4.24.4",
     "chalk-table": "^1.0.2",
     "cmd-shim": "^7.0.0",
+    "common-tags": "^1.8.2",
     "fast-content-type-parse": "^2.0.1",
     "has-flag": "4.0.0",
     "hpagent": "^1.2.0",

package-lock.json

@@ -84,6 +84,7 @@
     "browserslist": "4.24.4",
     "chalk-table": "^1.0.2",
     "cmd-shim": "^7.0.0",
+    "common-tags": "^1.8.2",
     "fast-content-type-parse": "^2.0.1",
     "has-flag": "4.0.0",
     "hpagent": "^1.2.0",
@@ -124,6 +125,7 @@
     "@rollup/pluginutils": "^5.1.4",
     "@types/blessed": "^0.1.25",
     "@types/cmd-shim": "^5.0.2",
+    "@types/common-tags": "^1.8.4",
     "@types/micromatch": "^4.0.9",
     "@types/mocha": "^10.0.10",
     "@types/mock-fs": "^4.13.4",

package.json

@@ -1,3 +1,4 @@
+import { stripIndents } from 'common-tags'
 import colors from 'yoctocolors-cjs'
 
 import { logger } from '@socketsecurity/registry/lib/logger'
@@ -95,17 +96,21 @@ async function run(
     // https://www.gnu.org/software/bash/manual/html_node/Exit-Status.html
     process.exitCode = 2
     logger.error(
-      `${colors.bgRed(colors.white('Input error'))}: Please provide the required fields:\n
-      - Scope must be "repo" or "org" ${badScope ? colors.red('(bad!)') : colors.green('(ok)')}\n
-      - The time filter must either be 7, 30 or 90 ${badTime ? colors.red('(bad!)') : colors.green('(ok)')}\n
-      ${scope === 'repo' ? `- Repository name using --repo when scope is "repo" ${badRepo ? colors.red('(bad!)') : colors.green('(ok)')}` : ''}\n
-      ${badFlags ? `- The \`--json\` and \`--markdown\` flags can not be used at the same time ${badFlags ? colors.red('(bad!)') : colors.green('(ok)')}` : ''}\n
-      ${badFile ? `- The \`--file\` flag is only valid when using \`--json\` or \`--markdown\` ${badFile ? colors.red('(bad!)') : colors.green('(ok)')}` : ''}\n
+      stripIndents`${colors.bgRed(colors.white('Input error'))}: Please provide the required fields:
+
+      - Scope must be "repo" or "org" ${badScope ? colors.red('(bad!)') : colors.green('(ok)')}
+
+      - The time filter must either be 7, 30 or 90 ${badTime ? colors.red('(bad!)') : colors.green('(ok)')}
+
+      ${scope === 'repo' ? `- Repository name using --repo when scope is "repo" ${badRepo ? colors.red('(bad!)') : colors.green('(ok)')}` : ''}
+
+      ${badFlags ? `- The \`--json\` and \`--markdown\` flags can not be used at the same time ${badFlags ? colors.red('(bad!)') : colors.green('(ok)')}` : ''}
+
+      ${badFile ? `- The \`--file\` flag is only valid when using \`--json\` or \`--markdown\` ${badFile ? colors.red('(bad!)') : colors.green('(ok)')}` : ''}
     `
-        .trim()
         .split('\n')
         .filter(s => !!s.trim())
-        .join('\n') + '\n'
+        .join('\n')
     )
     return
   }

src/commands/analytics/cmd-analytics.ts

@@ -3,6 +3,7 @@ import fs from 'node:fs/promises'
 // @ts-ignore
 import ScreenWidget from 'blessed/lib/widgets/screen'
 import contrib from 'blessed-contrib'
+import { stripIndents } from 'common-tags'
 
 import { logger } from '@socketsecurity/registry/lib/logger'
 
@@ -182,58 +183,59 @@ function renderMarkdown(
   days: number,
   repoSlug: string
 ): string {
-  return (
-    `# Socket Alert Analytics
+  return stripIndents`
+# Socket Alert Analytics
 
 These are the Socket.dev stats are analytics for the ${repoSlug ? `${repoSlug} repo` : 'org'} of the past ${days} days
 
-` +
-    [
-      [
-        'Total critical alerts',
-        mdTableStringNumber('Date', 'Counts', data['total_critical_alerts'])
-      ],
-      [
-        'Total high alerts',
-        mdTableStringNumber('Date', 'Counts', data['total_high_alerts'])
-      ],
-      [
-        'Total critical alerts added to the main branch',
-        mdTableStringNumber('Date', 'Counts', data['total_critical_added'])
-      ],
-      [
-        'Total high alerts added to the main branch',
-        mdTableStringNumber('Date', 'Counts', data['total_high_added'])
-      ],
-      [
-        'Total critical alerts prevented from the main branch',
-        mdTableStringNumber('Date', 'Counts', data['total_critical_prevented'])
-      ],
-      [
-        'Total high alerts prevented from the main branch',
-        mdTableStringNumber('Date', 'Counts', data['total_high_prevented'])
-      ],
-      [
-        'Total medium alerts prevented from the main branch',
-        mdTableStringNumber('Date', 'Counts', data['total_medium_prevented'])
-      ],
-      [
-        'Total low alerts prevented from the main branch',
-        mdTableStringNumber('Date', 'Counts', data['total_low_prevented'])
-      ]
-    ]
-      .map(([title, table]) => {
-        return `
+${[
+  [
+    'Total critical alerts',
+    mdTableStringNumber('Date', 'Counts', data['total_critical_alerts'])
+  ],
+  [
+    'Total high alerts',
+    mdTableStringNumber('Date', 'Counts', data['total_high_alerts'])
+  ],
+  [
+    'Total critical alerts added to the main branch',
+    mdTableStringNumber('Date', 'Counts', data['total_critical_added'])
+  ],
+  [
+    'Total high alerts added to the main branch',
+    mdTableStringNumber('Date', 'Counts', data['total_high_added'])
+  ],
+  [
+    'Total critical alerts prevented from the main branch',
+    mdTableStringNumber('Date', 'Counts', data['total_critical_prevented'])
+  ],
+  [
+    'Total high alerts prevented from the main branch',
+    mdTableStringNumber('Date', 'Counts', data['total_high_prevented'])
+  ],
+  [
+    'Total medium alerts prevented from the main branch',
+    mdTableStringNumber('Date', 'Counts', data['total_medium_prevented'])
+  ],
+  [
+    'Total low alerts prevented from the main branch',
+    mdTableStringNumber('Date', 'Counts', data['total_low_prevented'])
+  ]
+]
+  .map(
+    ([title, table]) =>
+      stripIndents`
 ## ${title}
 
 ${table}
-    `.trim()
-      })
-      .join('\n\n') +
-    '\n\n## Top 5 alert types\n\n' +
-    mdTableStringNumber('Name', 'Counts', data['top_five_alert_types']) +
-    '\n'
+`
   )
+  .join('\n\n')}
+
+## Top 5 alert types
+
+${mdTableStringNumber('Name', 'Counts', data['top_five_alert_types'])}
+`
 }
 
 function displayAnalyticsScreen(data: FormattedData): void {

src/commands/analytics/display-analytics.ts

@@ -1,3 +1,4 @@
+import { stripIndents } from 'common-tags'
 import colors from 'yoctocolors-cjs'
 
 import { logger } from '@socketsecurity/registry/lib/logger'
@@ -79,10 +80,10 @@ async function run(
     // https://www.gnu.org/software/bash/manual/html_node/Exit-Status.html
     process.exitCode = 2
     logger.error(
-      `
+      stripIndents`
       ${colors.bgRed(colors.white('Input error'))}: Please provide the required fields:\n
-      - Org name as the first argument ${!orgSlug ? colors.red('(missing!)') : colors.green('(ok)')}\n
-    `.trim()
+      - Org name as the first argument ${!orgSlug ? colors.red('(missing!)') : colors.green('(ok)')}
+    `
     )
     return
   }

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

@@ -1,3 +1,5 @@
+import { stripIndents } from 'common-tags'
+
 import { logger } from '@socketsecurity/registry/lib/logger'
 import { Separator, select } from '@socketsecurity/registry/lib/prompts'
 import { SocketSdkReturnType } from '@socketsecurity/sdk'
@@ -108,7 +110,6 @@ async function outputAsMarkdown(
   page: number,
   perPage: number
 ): Promise<void> {
-  let md
   try {
     const table = mdTable(auditLogs, [
       'event_id',
@@ -119,8 +120,8 @@ async function outputAsMarkdown(
       'user_agent'
     ])
 
-    md =
-      `
+    logger.log(
+      stripIndents`
 # Socket Audit Logs
 
 These are the Socket.dev audit logs as per requested query.
@@ -131,7 +132,8 @@ These are the Socket.dev audit logs as per requested query.
 - generated: ${new Date().toISOString()}
 
 ${table}
-      `.trim() + '\n'
+`
+    )
   } catch (e) {
     logger.error(
       'There was a problem converting the logs to JSON, please try without the `--json` flag'
@@ -140,8 +142,6 @@ ${table}
     process.exitCode = 1
     return
   }
-
-  logger.log(md)
 }
 
 function mdTable<

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

@@ -146,8 +146,11 @@ async function run(
   //
   //
   // if (cli.input.length)
-  //   logger.error(`${colors.bgRed(colors.white('Input error'))}: Please provide the required fields:\n
-  //     - Unexpected arguments\n
+  //   logger.error(
+  //     stripIndents`
+  //       ${colors.bgRed(colors.white('Input error'))}: Please provide the required fields:
+  //
+  //       - Unexpected arguments
   //   `)
   //   config.help(parentName, config)
   //   return

src/commands/cdxgen/cmd-cdxgen.ts

@@ -1,5 +1,6 @@
 import path from 'node:path'
 
+import { stripIndents } from 'common-tags'
 import colors from 'yoctocolors-cjs'
 
 import { logger } from '@socketsecurity/registry/lib/logger'
@@ -127,11 +128,11 @@ async function run(
     // options or missing arguments.
     // https://www.gnu.org/software/bash/manual/html_node/Exit-Status.html
     process.exitCode = 2
-    logger.error(
-      `${colors.bgRed(colors.white('Input error'))}: Please provide the required fields:\n
-      - The DIR arg is required ${!target ? colors.red('(missing!)') : target === '-' ? colors.red('(stdin is not supported)') : colors.green('(ok)')}\n
-      - Can only accept one DIR (make sure to escape spaces!) ${cli.input.length > 1 ? colors.red(`(received ${cli.input.length}!)`) : colors.green('(ok)')}\n`
-    )
+    logger.error(stripIndents`${colors.bgRed(colors.white('Input error'))}: Please provide the required fields:
+
+      - The DIR arg is required ${!target ? colors.red('(missing!)') : target === '-' ? colors.red('(stdin is not supported)') : colors.green('(ok)')}
+
+      - Can only accept one DIR (make sure to escape spaces!) ${cli.input.length > 1 ? colors.red(`(received ${cli.input.length}!)`) : colors.green('(ok)')}`)
     return
   }
 

src/commands/manifest/cmd-manifest-gradle.ts

@@ -1,5 +1,6 @@
 import path from 'node:path'
 
+import { stripIndents } from 'common-tags'
 import colors from 'yoctocolors-cjs'
 
 import { logger } from '@socketsecurity/registry/lib/logger'
@@ -133,9 +134,11 @@ async function run(
     // https://www.gnu.org/software/bash/manual/html_node/Exit-Status.html
     process.exitCode = 2
     logger.error(
-      `${colors.bgRed(colors.white('Input error'))}: Please provide the required fields:\n
-      - The DIR arg is required ${!target ? colors.red('(missing!)') : target === '-' ? colors.red('(stdin is not supported)') : colors.green('(ok)')}\n
-      - Can only accept one DIR (make sure to escape spaces!) ${cli.input.length > 1 ? colors.red(`(received ${cli.input.length}!)`) : colors.green('(ok)')}\n`
+      stripIndents`${colors.bgRed(colors.white('Input error'))}: Please provide the required fields:
+
+      - The DIR arg is required ${!target ? colors.red('(missing!)') : target === '-' ? colors.red('(stdin is not supported)') : colors.green('(ok)')}
+
+      - Can only accept one DIR (make sure to escape spaces!) ${cli.input.length > 1 ? colors.red(`(received ${cli.input.length}!)`) : colors.green('(ok)')}`
     )
     return
   }