edf2csv 0.8.53 → 0.8.55

package/dist/convert/run.d.ts

@@ -239,7 +239,10 @@ export declare function noSignalFile(file: EdfFile, plan: ConversionPlan): Diagn
  * hint the parser could not have known was false, and `withoutFileRateWarning` drops a header
  * diagnostic the plan supersedes. A conversion to a directory keeps every word.
  */
-export declare function withSidecarsUnwritten(diagnostics: readonly Diagnostic[], toStdout: boolean): Diagnostic[];
+export declare function withSidecarsNamed(diagnostics: readonly Diagnostic[], { toStdout, gzip }: {
+    toStdout: boolean;
+    gzip: boolean;
+}): Diagnostic[];
 /**
  * `--annotations-only` on a recording that has no annotations.
  *

package/dist/convert/run.js

@@ -98,10 +98,10 @@ export async function convert(inputPath, options = {}) {
                 readerHungUp,
                 annotationCount: 0,
                 // Over both lists, because the timing warnings are pushed onto the plan's.
-                diagnostics: withSidecarsUnwritten([
+                diagnostics: withSidecarsNamed([
                     ...withTimingPromiseKept(withoutFileRateWarning(file.diagnostics), timing.starts !== null),
                     ...plan.diagnostics,
-                ], true),
+                ], { toStdout: true, gzip: plan.gzip }),
                 plan,
                 file,
                 elapsedMs: Date.now() - startedAt,
@@ -197,7 +197,13 @@ export async function convert(inputPath, options = {}) {
             files: written,
             readerHungUp: false,
             annotationCount: annotationsWritten,
-            diagnostics: [...withTimingPromiseKept(withoutFileRateWarning(file.diagnostics), timing.starts !== null), ...plan.diagnostics, ...stale],
+            // The directory path needs it too: `--gzip` changes the names, and two of these
+            // sentences are a file name and nothing else. See withSidecarsNamed.
+            diagnostics: withSidecarsNamed([
+                ...withTimingPromiseKept(withoutFileRateWarning(file.diagnostics), timing.starts !== null),
+                ...plan.diagnostics,
+                ...stale,
+            ], { toStdout: false, gzip: plan.gzip }),
             plan,
             file,
             elapsedMs: Date.now() - startedAt,
@@ -1516,11 +1522,33 @@ export function noSignalFile(file, plan) {
  * hint the parser could not have known was false, and `withoutFileRateWarning` drops a header
  * diagnostic the plan supersedes. A conversion to a directory keeps every word.
  */
-export function withSidecarsUnwritten(diagnostics, toStdout) {
-    if (!toStdout)
+export function withSidecarsNamed(diagnostics, { toStdout, gzip }) {
+    if (!toStdout && !gzip)
         return [...diagnostics];
+    const channels = outputCsvName('channels', gzip);
+    const annotations = outputCsvName('annotations', gzip);
     return diagnostics.map((diagnostic) => {
-        if (diagnostic.code === 'START_TIME_UNREADABLE' &&
+        /*
+          The header's own `NO_SAMPLES`, which names the file that describes the channel it is
+          about — and under `--stdout` there is no such file, so the reassurance is empty:
+    
+              $ edf2csv one-empty-channel.edf --stdout > rows.csv
+              warning: Signal 1 ("unused") carries no samples at all (0 per data record).
+                       It is described in channels.csv but left out of the converted data.
+    
+          Under `--gzip` the file is there under another name. Both are settled here.
+        */
+        if (diagnostic.code === 'NO_SAMPLES' && diagnostic.hint?.startsWith('It is described in')) {
+            return {
+                ...diagnostic,
+                hint: toStdout
+                    ? 'It is left out of the converted data, and --stdout writes no channels.csv to ' +
+                        'describe it in — convert to a directory for that.'
+                    : `It is described in ${channels} but left out of the converted data.`,
+            };
+        }
+        if (toStdout &&
+            diagnostic.code === 'START_TIME_UNREADABLE' &&
             diagnostic.hint?.includes('metadata.json records')) {
             return {
                 ...diagnostic,
@@ -1533,9 +1561,13 @@ export function withSidecarsUnwritten(diagnostics, toStdout) {
             diagnostic.hint?.includes('onsets in annotations.csv')) {
             return {
                 ...diagnostic,
-                hint: 'Sample times are written from zero instead, so every row is present and the ' +
-                    'column increases. The onsets that recover absolute times are in the annotation ' +
-                    'channel; --stdout writes no annotations.csv, so convert to a directory for them.',
+                hint: toStdout
+                    ? 'Sample times are written from zero instead, so every row is present and the ' +
+                        'column increases. The onsets that recover absolute times are in the annotation ' +
+                        'channel; --stdout writes no annotations.csv, so convert to a directory for them.'
+                    : 'Sample times are written from zero instead, so every row is present and the ' +
+                        `column increases. Add the onsets in ${annotations} to recover absolute times if ` +
+                        'you need them.',
             };
         }
         return diagnostic;
@@ -1713,10 +1745,12 @@ bom) {
                 decimals: g.channels.map((c) => c.decimals),
             })),
         },
-        notes: [
+        notes: withSidecarsNamed([
             ...withTimingPromiseKept(withoutFileRateWarning(file.diagnostics), timedFromRecords),
             ...plan.diagnostics,
-        ].map((d) => ({
+        ], 
+        // metadata.json is only written into a directory, so this one is never the stdout case.
+        { toStdout: false, gzip: plan.gzip }).map((d) => ({
             code: d.code,
             severity: d.severity,
             message: d.message,