Normalize output of convertCondaToRequirements

Author: jdalton

src/commands/manifest/convert-conda-to-requirements.mts

@@ -1,29 +1,34 @@
-import fs from 'node:fs'
+import { existsSync, readFileSync } from 'node:fs'
 import path from 'node:path'
 
 import { logger } from '@socketsecurity/registry/lib/logger'
+import { stripAnsi } from '@socketsecurity/registry/lib/strings'
 
 import type { CResult } from '../../types.mts'
 
+function prepareContent(content: string): string {
+  return stripAnsi(content.trim())
+}
+
 export async function convertCondaToRequirements(
   filename: string,
   cwd: string,
   verbose: boolean,
-): Promise<CResult<{ contents: string; pip: string }>> {
-  let contents: string
+): Promise<CResult<{ content: string; pip: string }>> {
+  let content: string
   if (filename === '-') {
     if (verbose) {
       logger.info(`[VERBOSE] reading input from stdin`)
     }
 
-    const buf: string[] = []
-    contents = await new Promise((resolve, reject) => {
+    const strings: string[] = []
+    content = await new Promise((resolve, reject) => {
       process.stdin.on('data', chunk => {
         const input = chunk.toString()
-        buf.push(input)
+        strings.push(input)
       })
       process.stdin.on('end', () => {
-        resolve(buf.join(''))
+        resolve(prepareContent(strings.join('')))
       })
       process.stdin.on('error', e => {
         if (verbose) {
@@ -32,23 +37,23 @@ export async function convertCondaToRequirements(
         reject(e)
       })
       process.stdin.on('close', () => {
-        if (buf.length === 0) {
-          if (verbose) {
-            logger.error('stdin closed explicitly without data received')
-          }
-          reject(new Error('No data received from stdin'))
-        } else {
+        if (strings.length) {
           if (verbose) {
             logger.error(
               'warning: stdin closed explicitly with some data received',
             )
           }
-          resolve(buf.join(''))
+          resolve(prepareContent(strings.join('')))
+        } else {
+          if (verbose) {
+            logger.error('stdin closed explicitly without data received')
+          }
+          reject(new Error('No data received from stdin'))
         }
       })
     })
 
-    if (!contents) {
+    if (!content) {
       return {
         ok: false,
         message: 'Manifest Generation Failed',
@@ -62,17 +67,17 @@ export async function convertCondaToRequirements(
       logger.info(`[VERBOSE] target: ${filepath}`)
     }
 
-    if (!fs.existsSync(filepath)) {
+    if (!existsSync(filepath)) {
       return {
         ok: false,
         message: 'Manifest Generation Failed',
         cause: `The file was not found at ${filepath}`,
       }
     }
 
-    contents = fs.readFileSync(filepath, 'utf8')
+    content = readFileSync(filepath, 'utf8')
 
-    if (!contents) {
+    if (!content) {
       return {
         ok: false,
         message: 'Manifest Generation Failed',
@@ -84,59 +89,58 @@ export async function convertCondaToRequirements(
   return {
     ok: true,
     data: {
-      contents,
-      pip: convertCondaToRequirementsFromInput(contents),
+      content,
+      pip: convertCondaToRequirementsFromInput(content),
     },
   }
 }
 
 // Just extract the first pip block, if one exists at all.
 export function convertCondaToRequirementsFromInput(input: string): string {
-  const keeping: string[] = []
   let collecting = false
   let delim = '-'
   let indent = ''
-  input.split('\n').some(line => {
-    if (!line) {
-      // Ignore empty lines
-      return
+  const keeping: string[] = []
+  for (const line of input.split('\n')) {
+    const trimmed = line.trim()
+    if (!trimmed) {
+      // Ignore empty lines.
+      continue
     }
     if (collecting) {
       if (line.startsWith('#')) {
-        // Ignore comment lines (keep?)
-        return
+        // Ignore comment lines (keep?).
+        continue
       }
       if (line.startsWith(delim)) {
         // In this case we have a line with the same indentation as the
         // `- pip:` line, so we have reached the end of the pip block.
-        return true // the end
-      } else {
-        if (!indent) {
-          // Store the indentation of the block
-          if (line.trim().startsWith('-')) {
-            indent = line.split('-')[0] + '-'
-            if (indent.length <= delim.length) {
-              // The first line after the `pip:` line does not indent further
-              // than that so the block is empty?
-              return true
-            }
+        break
+      }
+      if (!indent) {
+        // Store the indentation of the block.
+        if (trimmed.startsWith('-')) {
+          indent = line.split('-')[0] + '-'
+          if (indent.length <= delim.length) {
+            // The first line after the `pip:` line does not indent further
+            // than that so the block is empty?
+            break
           }
         }
-        if (line.startsWith(indent)) {
-          keeping.push(line.slice(indent.length).trim())
-        } else {
-          // Unexpected input. bail.
-          return true
-        }
       }
-    } else {
-      // Note: the line may end with a line comment so don't === it.
-      if (line.trim().startsWith('- pip:')) {
-        delim = line.split('-')[0] + '-'
-        collecting = true
+      if (line.startsWith(indent)) {
+        keeping.push(line.slice(indent.length).trim())
+      } else {
+        // Unexpected input. bail.
+        break
       }
     }
-  })
+    // Note: the line may end with a line comment so don't === it.
+    else if (trimmed.startsWith('- pip:')) {
+      delim = line.split('-')[0] + '-'
+      collecting = true
+    }
+  }
 
-  return keeping.join('\n')
+  return prepareContent(keeping.join('\n'))
 }

src/commands/manifest/output-requirements.mts

@@ -8,7 +8,7 @@ import { serializeResultJson } from '../../utils/serialize-result-json.mts'
 import type { CResult, OutputKind } from '../../types.mts'
 
 export async function outputRequirements(
-  result: CResult<{ contents: string; pip: string }>,
+  result: CResult<{ content: string; pip: string }>,
   outputKind: OutputKind,
   out: string,
 ) {