edf2csv 0.5.89 → 0.5.91

package/CHANGELOG.md

@@ -3,6 +3,66 @@
 Notable changes to edf2csv. Versions follow [semantic versioning](https://semver.org); while the
 major version is 0, a minor bump may contain breaking changes.
 
+## 0.5.91
+
+### Fixed: `--start` at the recording's exact length was accepted when the length was a product
+
+`--start` at or past the end of a recording is an error, because the result would be an empty
+file that looks like a successful conversion. The guard compares against
+`recordCount * recordDuration` — and with a fractional record duration that product is not the
+number it prints as. 6003 records of 0.1s is 600.3000000000001, so on a recording `--info`
+calls "10m 0.3s":
+
+```
+$ edf2csv tenmin.edf --start 600.3 --out out
+warning: No samples fall inside the requested window (600.300s to 600.300s), so the signal
+         files hold their headers and no data.
+$ echo $?
+0
+```
+
+Exactly the empty conversion the error exists to prevent, and exactly what `--start 2` on a
+two-second recording is refused for. Which of the two you get depends on whether your record
+duration is a whole number.
+
+Compared with a relative epsilon now — the same shape the long layout uses to decide two sample
+times are one instant: well below any real sample interval, and well above the rounding that two
+routes to one quantity produce. `--start 600.2` on the same file still converts its ten samples.
+
+## 0.5.90
+
+### Fixed: the duration warnings described rows a window had excluded
+
+```
+$ edf2csv rec.edf --start 2 --end 3 --out out --strict
+warning: 1 annotation states a duration below zero ... The value is written to annotations.csv as the file gave it ... check these rows before using the durations.
+warning: 1 annotation states a duration that is not a number, so its duration_s cell is empty.
+--strict: 2 warnings raised, so this run is reported as a failure.
+
+$ cat out/annotations.csv
+onset_s,duration_s,description,record_index
+2.5,0.25,clean event,2
+```
+
+One row, with a populated, positive duration. There is no such value, no such cell and no such
+rows — and `--strict` failed the run over two events it never wrote.
+
+Both warnings are mine, from 0.5.55 and 0.5.58, and both were raised from the counts the
+decoder accumulates over the whole file while `annotations.csv` is filtered to the requested
+window. `--info` had the other half of it: on an EDF+D recording it printed "The value is
+written to annotations.csv as the file gave it" while writing no files at all.
+
+Counted from the events themselves now, after the same filter the writer applies, so the count
+and the sentence describe the same rows. An unreadable duration is carried on the event as
+`durationUnreadable`, because `duration: null` cannot say whether the file gave one — which is
+the ambiguity those warnings exist to flag, and a library caller now has it too. A negative
+duration needs no flag; the value is right there.
+
+`--info` raises them against the window it was given, so it predicts what the conversion will
+say rather than a different set. On a continuous EDF+ it still says nothing, because it does not
+read the whole annotation channel — that is the documented limit of a header read, not a
+regression.
+
 ## 0.5.89
 
 ### Fixed: the getting-started example asked for a channel the recording does not have

package/dist/cli.js

@@ -18,7 +18,7 @@ import process from 'node:process';
 import { EdfError } from './edf/errors.js';
 import { EdfFile } from './edf/reader.js';
 import { buildPlan, withoutFileRateWarning } from './convert/plan.js';
-import { ConversionError, USAGE_ERROR_CODES, convert, defaultOutputDir, stdoutRefusal, } from './convert/run.js';
+import { ConversionError, USAGE_ERROR_CODES, convert, defaultOutputDir, durationDiagnostics, stdoutRefusal, } from './convert/run.js';
 import { ChannelSelectionError } from './convert/channels.js';
 // Shared with the library so a bad option is the same error whichever way it arrived.
 import { OptionError } from './convert/options.js';
@@ -687,6 +687,17 @@ async function showInfo(input, shared, asJson, jsonIndent, batch = false, toStdo
           from describing the recording — and being told the command will not work is exactly
           what was asked. The conversion's own guard supplies the words, so there is one wording.
         */
+        /*
+          What the conversion would say about the durations it would write.
+    
+          Same window the conversion applies, so --info predicts the warnings rather than a
+          different set. Raised here rather than in the parser because the counts have to be of
+          the rows that reach annotations.csv — see durationDiagnostics.
+        */
+        plan.diagnostics.push(...durationDiagnostics(annotationData.annotations, {
+            from: plan.range.startSeconds,
+            to: plan.range.endSeconds,
+        }));
         if (toStdout) {
             const refusal = stdoutRefusal(file, plan);
             if (refusal) {