Move isErrnoException to utils/errors and stringJoinWithSeparateFinalSeparator to utils/strings

Author: jdalton

.config/rollup.test.config.mjs

@@ -18,7 +18,7 @@ const {
 
 export default () =>
   baseConfig({
-    input: ['alert-rules', 'misc', 'path-resolve'].reduce((o, k) => {
+    input: ['alert-rules', 'errors', 'path-resolve'].reduce((o, k) => {
       o[k] = `${rootSrcPath}/utils/${k}.ts`
       return o
     }, {}),

src/utils/alert-rules.ts

@@ -5,7 +5,7 @@ import { setTimeout as wait } from 'node:timers/promises'
 import config from '@socketsecurity/config'
 import { isObject } from '@socketsecurity/registry/lib/objects'
 
-import { isErrnoException } from './misc'
+import { isErrnoException } from './errors'
 import { getPublicToken, setupSdk } from './sdk'
 import { getSetting } from './settings'
 import constants from '../constants'

src/utils/errors.ts

@@ -9,3 +9,12 @@ export class InputError extends Error {
     this.body = body
   }
 }
+
+export function isErrnoException(
+  value: unknown
+): value is NodeJS.ErrnoException {
+  if (!(value instanceof Error)) {
+    return false
+  }
+  return (value as NodeJS.ErrnoException).code !== undefined
+}

src/utils/format-issues.ts

@@ -1,5 +1,5 @@
-import { stringJoinWithSeparateFinalSeparator } from './misc'
 import { pick } from './objects'
+import { stringJoinWithSeparateFinalSeparator } from './strings'
 
 import type { SocketSdkReturnType } from '@socketsecurity/sdk'
 
@@ -22,28 +22,24 @@ function getDesiredSeverities(
   lowestToInclude: SocketIssue['severity'] | undefined
 ): SocketIssue['severity'][] {
   const result: SocketIssue['severity'][] = []
-
   for (const severity of SEVERITIES_BY_ORDER) {
     result.push(severity)
     if (severity === lowestToInclude) {
       break
     }
   }
-
   return result
 }
 
 export function formatSeverityCount(
   severityCount: Record<SocketIssue['severity'], number>
 ): string {
   const summary: string[] = []
-
   for (const severity of SEVERITIES_BY_ORDER) {
     if (severityCount[severity]) {
       summary.push(`${severityCount[severity]} ${severity}`)
     }
   }
-
   return stringJoinWithSeparateFinalSeparator(summary)
 }
 
@@ -57,16 +53,13 @@ export function getSeverityCount(
   ) as Record<SocketIssue['severity'], number>
 
   for (const issue of issues) {
-    const value = issue.value
-
+    const { value } = issue
     if (!value) {
       continue
     }
-
     if (severityCount[value.severity] !== undefined) {
       severityCount[value.severity] += 1
     }
   }
-
   return severityCount
 }

src/utils/misc.ts

@@ -7,24 +7,3 @@ export function createDebugLogger(
     ? (...params: unknown[]): void => console.error(logSymbols.info, ...params)
     : () => {}
 }
-
-export function isErrnoException(
-  value: unknown
-): value is NodeJS.ErrnoException {
-  if (!(value instanceof Error)) {
-    return false
-  }
-  return (value as NodeJS.ErrnoException).code !== undefined
-}
-
-export function stringJoinWithSeparateFinalSeparator(
-  list: (string | undefined)[],
-  separator: string = ' and '
-): string {
-  const values = list.filter(value => !!value)
-  if (values.length < 2) {
-    return values[0] || ''
-  }
-  const finalValue = values.pop()
-  return values.join(', ') + separator + finalValue
-}

src/utils/strings.ts

@@ -0,0 +1,15 @@
+export function stringJoinWithSeparateFinalSeparator(
+  list: (string | undefined)[],
+  separator: string = ' and '
+): string {
+  const values = list.filter(Boolean)
+  const { length } = values
+  if (!length) {
+    return ''
+  }
+  if (length === 1) {
+    return values[0]
+  }
+  const finalValue = values.pop()
+  return `${values.join(', ')}${separator}${finalValue}`
+}

test/misc.test.ts test/errors.test.tstest/misc.test.ts renamed to test/errors.test.ts

@@ -3,7 +3,7 @@ import { readFileSync } from 'node:fs'
 import path from 'node:path'
 import { describe, it } from 'node:test'
 
-import { isErrnoException } from './dist/misc'
+import { isErrnoException } from './dist/errors'
 
 const testPath = __dirname