edf2csv 0.8.69 → 0.8.71

package/dist/convert/run.d.ts

@@ -239,7 +239,7 @@ export declare function noSignalFile(file: EdfFile, plan: ConversionPlan): Diagn
  *
  * `writesSignals` rather than the option, because the plan is what settles it.
  */
-export declare function withSignalTableUnwritten(diagnostics: readonly Diagnostic[], writesSignals: boolean): Diagnostic[];
+export declare function withSignalTableUnwritten(diagnostics: readonly Diagnostic[], writesSignals: boolean, gzip: boolean): Diagnostic[];
 /**
  * The sidecar files a `--stdout` run does not write, taken out of the sentences about them.
  *

package/dist/convert/run.js

@@ -101,7 +101,7 @@ export async function convert(inputPath, options = {}) {
                 diagnostics: withSidecarsNamed(withSignalTableUnwritten([
                     ...withTimingPromiseKept(withoutFileRateWarning(file.diagnostics), timing.starts !== null),
                     ...plan.diagnostics,
-                ], plan.writeSignals), { toStdout: true, gzip: plan.gzip }),
+                ], plan.writeSignals, plan.gzip), { toStdout: true, gzip: plan.gzip }),
                 plan,
                 file,
                 elapsedMs: Date.now() - startedAt,
@@ -203,7 +203,7 @@ export async function convert(inputPath, options = {}) {
                 ...withTimingPromiseKept(withoutFileRateWarning(file.diagnostics), timing.starts !== null),
                 ...plan.diagnostics,
                 ...stale,
-            ], plan.writeSignals), { toStdout: false, gzip: plan.gzip }),
+            ], plan.writeSignals, plan.gzip), { toStdout: false, gzip: plan.gzip }),
             plan,
             file,
             elapsedMs: Date.now() - startedAt,
@@ -1481,7 +1481,15 @@ export function stdoutRefusal(file, plan) {
             ? `--stdout has no signal data to write: this recording has no signal channels, ` +
                 `only ${file.header.isBdf ? 'BDF+' : 'EDF+'} annotations.`
             : '--stdout has no signal data to write: nothing was selected that carries samples.', file.dataSignals.length === 0
-            ? 'Convert to a directory to get its annotations.csv, or drop --stdout.'
+            ? /*
+             Named the way that conversion would name it, since `--gzip` is already on the
+             command line this is refusing. This hint is nothing but a command to run, and the
+             command it names writes `annotations.csv.gz` — so a reader who follows it finds
+             nothing under the name they were given. Same fault 0.8.48 fixed for the warnings,
+             in the one refusal that names a file.
+          */
+                `Convert to a directory to get its ${outputCsvName('annotations', plan.gzip)}, or ` +
+                    `drop --stdout.`
             : 'Check --channels and the requested window, or convert to a directory instead.');
     }
     // The long layout is one table whatever the rates are, so it has nothing to refuse.
@@ -1566,9 +1574,20 @@ export function noSignalFile(file, plan) {
  *
  * `writesSignals` rather than the option, because the plan is what settles it.
  */
-export function withSignalTableUnwritten(diagnostics, writesSignals) {
+export function withSignalTableUnwritten(diagnostics, writesSignals, gzip) {
     if (writesSignals)
         return [...diagnostics];
+    /*
+      The sidecars named here are named as the run writes them.
+  
+      These sentences send the reader to the one file an `--annotations-only` run does write, and
+      said `channels.csv` to a `--gzip` run that writes `channels.csv.gz` — five hints pointing at
+      a name that is not in the directory, one of them beside the `_ch` collision hint that 0.8.48
+      had already taught to say `channels.csv.gz`. So a single run named both spellings, and only
+      the second one existed.
+    */
+    const channelsFile = outputCsvName('channels', gzip);
+    const annotationsFile = outputCsvName('annotations', gzip);
     return diagnostics.map((diagnostic) => {
         /*
           And the three calibration warnings, whose hints are about cells.
@@ -1609,7 +1628,9 @@ export function withSignalTableUnwritten(diagnostics, writesSignals) {
             return {
                 ...diagnostic,
                 message: diagnostic.message
-                    .replace("as the channel's name in signals.csv", "as the channel's name in channels.csv's column cell")
+                    .replace("as the channel's name in signals.csv", `as the channel's name in ${channelsFile}'s column cell`)
+                    // Matched on the name the header diagnostic used, which the line above has not
+                    // touched: it renames the first mention, and this collapses the second.
                     .replace("column cell and in channels.csv's", 'column cell and in its')
                     .replace(' in any conversion that writes one', ''),
             };
@@ -1620,28 +1641,28 @@ export function withSignalTableUnwritten(diagnostics, writesSignals) {
                 ...diagnostic,
                 hint: 'Their names are suffixed with the signal number so they stay distinguishable. ' +
                     '--annotations-only writes no signal table, so the suffixed names appear only in ' +
-                    "channels.csv's column cells.",
+                    `${channelsFile}'s column cells.`,
             };
         }
         if (diagnostic.code === 'DEGENERATE_DIGITAL_RANGE') {
             return {
                 ...diagnostic,
                 hint: 'No samples are converted with --annotations-only, so there are no cells to leave ' +
-                    'empty. channels.csv still records the digital range the header gives.',
+                    `empty. ${channelsFile} still records the digital range the header gives.`,
             };
         }
         if (diagnostic.code === 'DEGENERATE_PHYSICAL_RANGE') {
             return {
                 ...diagnostic,
                 message: diagnostic.message.replace('so every sample converts to the same value.', 'so every sample would convert to the same value.'),
-                hint: 'No samples are converted with --annotations-only. channels.csv still records the ' +
-                    'calibration, one point wide.',
+                hint: `No samples are converted with --annotations-only. ${channelsFile} still records ` +
+                    'the calibration, one point wide.',
             };
         }
         if (diagnostic.code === 'INVERTED_PHYSICAL_RANGE') {
             return {
                 ...diagnostic,
-                hint: 'No samples are converted with --annotations-only. channels.csv records the ' +
+                hint: `No samples are converted with --annotations-only. ${channelsFile} records the ` +
                     'physical minimum and maximum in the order the header gives them, inversion included.',
             };
         }
@@ -1651,15 +1672,15 @@ export function withSignalTableUnwritten(diagnostics, writesSignals) {
             return {
                 ...diagnostic,
                 hint: '--annotations-only writes no signal rows, so nothing here is timed from the ' +
-                    "records. annotations.csv carries each event's own onset, and the record it came " +
-                    'from in record_index.',
+                    `records. ${annotationsFile} carries each event's own onset, and the record it ` +
+                    'came from in record_index.',
             };
         }
         if (diagnostic.hint.startsWith('Rows are written in file order')) {
             return {
                 ...diagnostic,
                 hint: '--annotations-only writes no signal rows, so no time column is affected. ' +
-                    "annotations.csv's record_index still names the record each event came from.",
+                    `${annotationsFile}'s record_index still names the record each event came from.`,
             };
         }
         if (diagnostic.hint.startsWith('Sample times are written from zero')) {
@@ -1714,8 +1735,10 @@ export function withSidecarsNamed(diagnostics, { toStdout, gzip }) {
             return {
                 ...diagnostic,
                 message: diagnostic.message
-                    .replace(/\bsignals\.csv\b/gu, outputCsvName('signals', true))
-                    .replace(/\bchannels\.csv\b/gu, channels),
+                    // Past a name the pass above already suffixed: `channels.csv.gz` contains
+                    // `channels.csv`, and a second rename made it `channels.csv.gz.gz`.
+                    .replace(/\bsignals\.csv\b(?!\.gz)/gu, outputCsvName('signals', true))
+                    .replace(/\bchannels\.csv\b(?!\.gz)/gu, channels),
             };
         }
         /*
@@ -1938,7 +1961,7 @@ bom) {
         notes: withSidecarsNamed(withSignalTableUnwritten([
             ...withTimingPromiseKept(withoutFileRateWarning(file.diagnostics), timedFromRecords),
             ...plan.diagnostics,
-        ], plan.writeSignals), 
+        ], plan.writeSignals, plan.gzip), 
         // metadata.json is only written into a directory, so this is never the stdout case.
         { toStdout: false, gzip: plan.gzip }).map((d) => ({
             code: d.code,