edf2csv 0.8.91 → 0.8.92

package/dist/convert/run.js

@@ -10,6 +10,8 @@ import { lstat, mkdir, readdir, stat, writeFile } from 'node:fs/promises';
 import { finished } from 'node:stream/promises';
 import { createGzip, gzipSync } from 'node:zlib';
 import path from 'node:path';
+// A destination is whatever the caller's shell handed over; see printable's own comment.
+import { printable } from '../format/unprintable.js';
 import { EdfFile } from '../edf/reader.js';
 import { describeFormat, formatRate, formatRates, formatWallClock, startsFormula } from '../edf/header.js';
 import { EdfError } from '../edf/errors.js';
@@ -345,6 +347,22 @@ async function assertInputDoesNotOverlapOutputs(inputPath, outputDir, file, plan
     }
 }
 async function prepareOutputDir(dir, force) {
+    /*
+      The destination, quoted into every refusal below, and shown rather than pasted.
+  
+      `--out` is whatever the caller's shell handed over, and `printableLines` escapes every
+      control byte in a message except the one that makes a line break — it splits on those
+      first, to keep the author's own lines. So a newline in a destination cut the refusal's
+      first line in half:
+  
+          error: "out/ex
+                 ists" already exists.
+  
+      which is the line this tool's comments keep insisting stays whole, because it is the one a
+      log gets grepped for. Same in `EdfFile.open`'s path and in a `--channels` term; all three
+      go through `printable` now, where the summary and the report have always put them.
+    */
+    const shownDir = printable(dir);
     /*
       Claim the directory with a single atomic mkdir rather than asking whether it exists
       and then creating it.
@@ -369,9 +387,9 @@ async function prepareOutputDir(dir, force) {
             // directory inside a file". Name the real obstacle instead of the errno.
             const info = await stat(parent).catch(() => null);
             if (info && !info.isDirectory()) {
-                throw new ConversionError('OUTPUT_UNWRITABLE', `Cannot create "${dir}": "${parent}" is a file, not a directory.`, 'Choose a destination whose parent directories are directories, with --out.');
+                throw new ConversionError('OUTPUT_UNWRITABLE', `Cannot create "${shownDir}": "${printable(parent)}" is a file, not a directory.`, 'Choose a destination whose parent directories are directories, with --out.');
             }
-            throw new ConversionError('OUTPUT_UNWRITABLE', `Cannot create "${dir}": ${describeFsError(cause)}.`, createHint(cause));
+            throw new ConversionError('OUTPUT_UNWRITABLE', `Cannot create "${shownDir}": ${describeFsError(cause)}.`, createHint(cause));
         }
     }
     let claimed = true;
@@ -380,7 +398,7 @@ async function prepareOutputDir(dir, force) {
     }
     catch (cause) {
         if (cause.code !== 'EEXIST') {
-            throw new ConversionError('OUTPUT_UNWRITABLE', `Cannot create "${dir}": ${describeFsError(cause)}.`, createHint(cause));
+            throw new ConversionError('OUTPUT_UNWRITABLE', `Cannot create "${shownDir}": ${describeFsError(cause)}.`, createHint(cause));
         }
         claimed = false;
     }
@@ -389,7 +407,7 @@ async function prepareOutputDir(dir, force) {
         // --force means "replace my previous output", not "write output files into
         // whatever this happens to be". Pointing it at a regular file needs saying so.
         if (existing && !existing.isDirectory()) {
-            throw new ConversionError('OUTPUT_UNWRITABLE', `"${dir}" is a file, but the converted data needs a directory.`, 'Choose a directory with --out.');
+            throw new ConversionError('OUTPUT_UNWRITABLE', `"${shownDir}" is a file, but the converted data needs a directory.`, 'Choose a directory with --out.');
         }
         /*
           A link to nothing, which `stat` cannot see and `mkdir` will not write through.
@@ -411,7 +429,7 @@ async function prepareOutputDir(dir, force) {
           a mount that has since gone.
         */
         if (!existing && (await lstat(dir).catch(() => null))) {
-            throw new ConversionError('OUTPUT_UNWRITABLE', `"${dir}" is a symbolic link to something that does not exist, so nothing can be ` +
+            throw new ConversionError('OUTPUT_UNWRITABLE', `"${shownDir}" is a symbolic link to something that does not exist, so nothing can be ` +
                 `written there.`, 'Remove the link, or choose a directory with --out. --force writes into a directory ' +
                 'that is already there, and a link to nowhere is not one.');
         }
@@ -433,7 +451,7 @@ async function prepareOutputDir(dir, force) {
               metadata.json describing only the second — which is exactly the outcome a reader who
               was told the directory would be replaced does not expect, and does not check for.
             */
-            throw new ConversionError('OUTPUT_EXISTS', `"${dir}" already exists.`, 'Pass --force to write into it, leaving whatever else it holds, or --out to choose ' +
+            throw new ConversionError('OUTPUT_EXISTS', `"${shownDir}" already exists.`, 'Pass --force to write into it, leaving whatever else it holds, or --out to choose ' +
                 'a different directory.');
         }
     }