edf2csv 0.5.0 → 0.5.13

package/CHANGELOG.md

@@ -3,6 +3,298 @@
 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.13
+
+### Fixed: the test suite reached for a website dependency, and every publish since 0.5.1 failed
+
+0.5.1 stopped the link checker carrying its own copy of the site's slug rule and had it
+import `slugify` from `website/src/lib/markdown.js` instead. That file imports `marked`.
+
+The package has no dependencies, deliberately, and `npm test` runs with none installed —
+which is a claim the correctness page makes in as many words. So the release workflow failed
+on `Cannot find package 'marked'` for 0.5.1 through 0.5.12, and npm stayed on 0.5.0 while
+twelve tags, twelve GitHub releases and twelve sets of green local tests said otherwise. It
+passed here because this machine has the website's `node_modules` sitting next to the
+package's.
+
+`slugify` is its own module now, `website/src/lib/slug.js`, importing nothing. The renderer
+imports it and re-exports it; the test imports it directly. Both callers share the function
+without sharing a dependency graph.
+
+Verified the way it should have been the first time: a fresh clone, `npm ci`, no website
+`node_modules` anywhere, all 253 tests passing.
+
+## 0.5.12
+
+### Fixed: the summary claimed a conversion for a reader that stopped reading
+
+`edf2csv recording.edf --stdout | head -1` announced "Wrote 52,507 rows to stdout" for a
+102,400-row recording of which the reader took one line. That number is neither total. It is
+however many rows had been formatted before the closed pipe was noticed — a figure with no
+meaning outside the implementation, presented as the result of the run.
+
+Piping to `head` is an ordinary thing to type and not a failure, so it still exits 0. It is
+not a conversion either, so it no longer gets a conversion's summary: it says the reader
+closed the pipe, after how many rows had been written, and that the recording was not
+converted in full. How many reached the reader cannot be known from this side. That it
+stopped early can.
+
+`ConvertResult` gains `readerHungUp` for callers who need to tell the two apart.
+
+### Fixed: `--gzip` dropped the unit from every line of the summary
+
+```
+Wrote out
+  signals.csv.gz      300
+  annotations.csv.gz    3
+  channels.csv.gz       1
+```
+
+The unit was attached to names ending in `.csv`, and `.csv.gz` does not, so the counts stood
+on their own with nothing saying what they counted — beside an uncompressed run of the same
+recording that says `300  rows`. A compressed CSV's rows are still rows.
+
+## 0.5.11
+
+### Fixed: six documentation claims that contradicted the tool or each other
+
+- **cli-reference explained the derived decimal ceiling as 20.** It has been 100 since
+  0.4.74. The sentence was reasoning about a magnetometer needing more places than a
+  microvolt EEG and then giving the number that no longer applies — and 20 is still right
+  for `--decimals`, which made the two easy to conflate. Both are now stated, with what each
+  bounds.
+- **The `--decimals` error example could never be printed.** It showed
+  `--decimals must be a whole number between 0 and 20, got "16"`. 16 is inside 0 to 20.
+- **The exit-code list said "more than one input file" is a usage error.** Batch conversion
+  of several files is a documented feature of the same page.
+- **api.md gave `ConversionError.code` two different value sets** thirty lines apart: seven
+  in the table, four in the prose.
+- **The README's headline CSV sample was not output the tool can produce.** A 256 Hz
+  recording writes `time_s` to eight places, because 1/256 terminates at eight; the sample
+  showed six, and values to match. It is a real conversion now.
+- **recipes.md showed a fifth `sleep-study.edf`** — four channels, 42.2 MB, plain EDF —
+  where the rest of the site shows one recording. 0.4.78 fixed exactly this and the guard it
+  added never looked at that page: it held a hard-coded list of three, and matched only the
+  exact spelling `File       sleep-study.edf`, while recipes wrote `./sleep-study.edf`.
+
+The guard now reads every page in `website/content` and accepts either spelling. A check
+against drift with a hard-coded list of where drift can happen is a check against the drift
+you already found.
+
+Also: the correctness page's captured `npm test` block claimed 39 suites where the runner
+reports 48. That number was the one thing in the block nothing was reading; it is counted
+from the files now, like the test counts beside it.
+
+## 0.5.10
+
+### Fixed: `VALUE_RESOLUTION` reported `--decimals` back at the person who typed it
+
+The warning 0.4.74 added is about a ceiling: a channel whose quantization step is below
+1e-98 needs more decimal places than `toFixed` will print, so consecutive digital codes come
+out as the same text. The check asked "does this channel need more decimals than it is
+getting", which is also true — deliberately — every time `--decimals` is used to ask for
+fewer.
+
+So an ordinary EEG at `--decimals 2` raised it on every channel. And because `--strict`
+turns any diagnostic into a non-zero exit, `--decimals 2 --strict` could not succeed on any
+recording at all: the flag and the flag were in a fight.
+
+Raised only when the precision was derived now. `--decimals` is a choice, and the tool takes
+it at its word. The ceiling case is unchanged, and still warns, because nobody chose 100.
+
+## 0.5.9
+
+### Fixed: the long layout ordered tied channels by sampling rate, not by the file's order
+
+Documented as "within one time in the order the file declares its channels", which is also
+what `channels.csv` lists and what the wide layout's columns do. What it actually did was
+descending sampling rate: rate groups are sorted largest first, because that is how the wide
+layout names its files, and emitting a tie one group at a time let that leak into the rows.
+
+A recording declaring `slow, medium, fast` wrote `fast, medium, slow` at every instant where
+all three had a sample. Most recordings hide it by declaring their fastest channels first,
+which is why the fixtures did not catch it — a new one, `ascending-rates.edf`, declares them
+the other way round.
+
+Now every channel due at one instant is collected and emitted in signal-index order, which
+is the file's own order and the only one a reader can predict. Checked across all 41
+convertible fixtures: each channel's sequence of values is identical between the two
+layouts.
+
+### Fixed: `onProgress` reported more bytes written than the file being written
+
+`bytesWritten` summed each group's writer. The long layout's groups share one, so a
+three-rate conversion reported three times the real figure — a progress meter that runs past
+the end.
+
+## 0.5.8
+
+### Fixed: 0.5.4 fixed half of the stdout audit and left the compressed half
+
+`--stdout --layout long --gzip` still failed, and louder than before. On a 40-rate recording
+it claimed "606684 of 622240 bytes did not reach the destination" over a compressed stream
+that decompresses to every row, and printed Node's `MaxListenersExceededWarning` to stderr
+on the way past ten listeners.
+
+Same arithmetic as 0.5.4, different shape, which is why it survived the fix. Uncompressed,
+the audit adds up each writer's byte count — a sum, fixed by counting distinct writers.
+Compressed, it subscribes to the compressor's `data` events — and the subscription was made
+once per rate group, on the one compressor they share, so every chunk was counted once per
+group.
+
+Subscribed once per stream now. The stream is byte-identical to what `--out --gzip` writes.
+
+## 0.5.7
+
+### Fixed: a folder that could not be read was reported as a folder holding nothing
+
+Both got the same exit 2 and the same sentence — "No EDF or BDF recordings found in
+/data/locked" — printed directly beneath a line saying the folder could not be read. The two
+lines contradicted each other, and the exit code sided with the wrong one.
+
+Exit 2 is this tool's code for "the command itself was wrong". The command was fine; the
+filesystem refused. A script reading the status was being told to fix its arguments when
+what needed fixing was a permission, and the sentence stated a fact the run was in no
+position to state: nothing was found because nothing was looked at.
+
+An unreadable path now exits 1 and says so — "whether it holds recordings is unknown". An
+empty folder is still exit 2 and still says it is empty, which it can, having looked.
+
+## 0.5.6
+
+### Fixed: memory followed the number of output tables, not the size of the recording
+
+Every rate group opened its own writer at the 1 MiB flush threshold, so pending output was
+group count times a megabyte before anything drained. A 6.5 MB recording with forty sampling
+rates therefore needed forty megabytes of buffer and died with a raw V8 heap out-of-memory —
+exit 134, a native stack, nothing written, no catchable error for a library caller — under a
+96 MB cap. The site advertises 48 MB.
+
+Nothing about that recording is large. The fan-out is: an EDF header can declare thousands of
+channels, and a research montage really does mix a dozen rates. The one number that mattered
+was the one the design was not looking at.
+
+The budget is one buffer for the conversion now, split across the tables, with a floor so a
+run does not turn into a flush per row. Single-rate recordings — nearly all of them — keep
+exactly the buffer they had, and forty tables cost 2.5 MB instead of 40. The same 6.5 MB
+recording completes under a 32 MB cap, and its CSVs are byte-identical to a run with a
+gigabyte. Throughput on an eight-hour single-rate conversion is unchanged.
+
+The long layout was never affected: it shares one writer across the groups, which is what
+0.5.0 had to do to keep its rows in order.
+
+## 0.5.5
+
+### Fixed: three things `--stdout` said about itself that were not true
+
+**The help forbade what the tool does.** `--help` and the README both described `--stdout`
+as "(single-rate recordings only)" — twenty lines above the paragraph, in the same help text,
+explaining that `--layout long` is how a mixed-rate recording streams. 0.5.0 lifted the
+restriction and left the line describing it.
+
+**`--out` and `--checksum` were accepted and dropped in silence.** `--out` named a directory
+that was never created, so a run that wrote nowhere looked like it had written somewhere.
+`--checksum` was worse than useless: the hash is computed before the first record is read,
+which is a second full pass over the input, and the only file it is ever written to is the
+`metadata.json` that `--stdout` does not write. A recording large enough to want a checksum
+is large enough to notice being read twice for nothing. Both are usage errors now, which is
+what `--stdout --json` and `--stdout --annotations-only` already were.
+
+**A folder holding one recording was refused as "1 recordings".** "--stdout writes a single
+CSV, so it cannot take 1 recordings" — ungrammatical, and wrong on its face, since one
+recording is exactly what it can take. What it cannot take is a folder, whose contents are
+not known until it is walked. It says that instead, and names the recording inside so you can
+run that.
+
+## 0.5.4
+
+### Fixed: `--stdout --layout long` failed with a disk-full error on a file that was complete
+
+The command the `--layout` documentation gives — `edf2csv recording.edf --stdout --layout
+long > signals.csv` — exited 1 on every mixed-rate recording, saying "64086 of 96129 bytes
+did not reach the destination" and advising that the disk was almost certainly full. The
+file on disk was complete, every row present.
+
+`--stdout` audits itself: a filesystem that fills up mid-write returns a short count rather
+than an error, and stdout has nothing written after it to trip over, so the run compares how
+far the file grew against how many bytes it handed over. That count was taken once per rate
+group. 0.5.0's long layout gives every group the same writer, so a three-rate recording
+counted its 32,043 bytes three times, was credited with 96,129, and concluded that two
+thirds of them had been lost.
+
+Counted once per writer now. It only bit when stdout was redirected to a regular file, which
+is the one case the audit applies to and exactly what the documentation shows — through a
+pipe the audit declines, so the feature looked fine everywhere it was demonstrated
+interactively.
+
+## 0.5.3
+
+### Fixed: the long layout promised sorted rows for a file it cannot sort
+
+0.5.0 said, flatly, "rows come out sorted by `time_s`" — on two pages and in its own release
+notes. The promise rests on something true but conditional: every sample of a record falls
+inside that record's span, so writing records in file order gives times in order.
+
+A discontinuous recording is free to store its records in a different order than it
+timestamps them. Nothing in EDF+ forbids it. Then the rows come out 10s, 5s, 0s, and the
+tool was already warning that they would — "2 data records start earlier than the record
+before it. Rows are written in file order, so the time column will not increase
+monotonically" — while the page for the new feature promised the opposite.
+
+The claim is qualified now, in both places, and points at the warning. What has not changed
+is the part that matters: every sample is written, once, in file order, with the time the
+file gives it. A fixture, `records-backwards.edf`, holds all of that — including the check
+that the times really do go backwards, so the test cannot quietly stop testing anything.
+
+## 0.5.2
+
+### Fixed: the disk-full tests destroyed any other run on the machine
+
+`test/stdout-audit.test.js` needs a filesystem of a known small size, so it makes one with
+`hdiutil`. The image and the volume were constants — `/tmp/edf2csv-audit.dmg` and
+`/Volumes/edf2csvaudit` — and every run began by detaching that volume and deleting that
+image, whoever they belonged to.
+
+So two runs at once did not queue, they destroyed each other. Three concurrent copies of the
+file fail 10 of their 12 tests, the second run pulling the disk out from under the first
+mid-write. This is not exotic: `node --test` runs test files in parallel, re-running a suite
+before the last one has finished is ordinary, and CI machines run more than one job. It
+surfaced here as a single mystery failure in an otherwise green run, which is the worst way
+for it to surface — a flaky test costs more than the one it fails, because it makes every
+other result a question.
+
+The image and volume are named for the process now, and the mount point is read from
+`hdiutil` rather than assumed: macOS renames a volume whose name is already taken —
+`edf2csvaudit 1` — so assuming the path meant a colliding run would have quietly written
+into the other run's volume. Four concurrent copies now pass all sixteen and leave nothing
+mounted.
+
+## 0.5.1
+
+### Fixed: 0.5.0 shipped a feature and told none of the pages that argue for it
+
+`--layout long` is the answer to a question six pages ask, and every one of them still said
+the split into a file per rate was the only outcome. sampling-rates.md spends a section
+listing the three ways a wide table can fill the cells a slow channel never recorded, and
+never mentioned the fourth option, which is not to make the table wide. faq.md's "why did I
+get several signals files" gave no way to get one. cli-reference listed "more than one
+sampling rate" as a flat exit-2 condition for `--stdout` — which `--layout long` makes false,
+while the tool's own error message for that case already names the flag.
+
+All six now say so, with real output. A test holds the rule: a page that tells the reader a
+mixed-rate recording becomes several files has to also tell them about the layout that does
+not.
+
+### Fixed: the link checker had its own idea of where links point
+
+Added in 0.4.67 with its own copy of the site's slug rule — lowercase, then every run of
+non-alphanumerics to a hyphen. The site's keeps hyphens as themselves, so `## --layout` is
+`#--layout` on the page and was `#layout` here. It would have called the correct links added
+above broken, and it would have passed a link to `#layout` that resolves to nothing.
+
+It imports `slugify` from `website/src/lib/markdown.js` now, which is the function that
+generates the ids, so a link checker and the links agree by construction.
+
 ## 0.5.0
 
 ### Added: `--layout long`, so a mixed-rate recording can be one table

package/README.md

@@ -24,8 +24,8 @@ recording_csv/
 
 ```csv
 time_s,FP1-F7,F7-T7,T7-P7
-0.000000,-17.778,39.267,-3.712
-0.003906,0.195,0.195,0.195
+0.00000000,0.061,113.126,99.939
+0.00390625,37.546,123.871,84.188
 ```
 
 `time_s` is seconds from the start of the recording. The other columns are the
@@ -70,7 +70,8 @@ npx edf2csv recording.edf --start 30m --duration 5m
   -q, --quiet            Less output
       --json             Machine-readable JSON on stdout (works with --info too)
       --strict           Exit 1 if the recording raised any warning
-      --stdout           Write the CSV to stdout (single-rate recordings only)
+      --stdout           Write the CSV to stdout (one table only: one sampling
+                         rate, or --layout long)
   -h, --help             Help
   -V, --version          Version
 ```

package/dist/cli/report.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"report.d.ts","sourceRoot":"","sources":["../../src/cli/report.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAGhD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEzD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAuBvD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAK9C;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,SAAK,GAAG,MAAM,CAKhE;AAED,0FAA0F;AAC1F,wBAAgB,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,cAAc,GAAG,MAAM,CAgHtE;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,GAAE,MAAM,GAAG,IAAQ,GAAG,MAAM,CAwD/F;AAED,mEAAmE;AACnE,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,SAAS,UAAU,EAAE,GAAG,MAAM,CAS5E;AAED,wBAAgB,aAAa,CAAC,MAAM,EAAE,aAAa,GAAG,MAAM,CAU3D;AAED,wBAAgB,WAAW,CAAC,MAAM,EAAE,aAAa,EAAE,MAAM,GAAE,MAAM,GAAG,IAAQ,GAAG,MAAM,CAcpF"}
+{"version":3,"file":"report.d.ts","sourceRoot":"","sources":["../../src/cli/report.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAGhD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEzD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAuBvD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAK9C;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,SAAK,GAAG,MAAM,CAKhE;AAED,0FAA0F;AAC1F,wBAAgB,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,cAAc,GAAG,MAAM,CAgHtE;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,GAAE,MAAM,GAAG,IAAQ,GAAG,MAAM,CAwD/F;AAED,mEAAmE;AACnE,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,SAAS,UAAU,EAAE,GAAG,MAAM,CAS5E;AAED,wBAAgB,aAAa,CAAC,MAAM,EAAE,aAAa,GAAG,MAAM,CAgB3D;AAED,wBAAgB,WAAW,CAAC,MAAM,EAAE,aAAa,EAAE,MAAM,GAAE,MAAM,GAAG,IAAQ,GAAG,MAAM,CAcpF"}

package/dist/cli/report.js

@@ -247,7 +247,13 @@ export function formatSummary(result) {
     const lines = [];
     const rows = [];
     for (const file of result.files) {
-        rows.push([`  ${file.name}`, file.rows.toLocaleString('en-US'), file.name.endsWith('.csv') ? 'rows' : '']);
+        // `.csv.gz` is still a CSV, and its rows are still rows. The suffix test dropped the
+        // unit from every line of a --gzip summary, so the numbers stood on their own.
+        rows.push([
+            `  ${file.name}`,
+            file.rows.toLocaleString('en-US'),
+            /\.csv(\.gz)?$/u.test(file.name) ? 'rows' : '',
+        ]);
     }
     lines.push(`Wrote ${result.outputDir}`);
     lines.push(table(rows, new Set([1])));

package/dist/cli/report.js.map

@@ -1 +1 @@
-{"version":3,"file":"report.js","sourceRoot":"","sources":["../../src/cli/report.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAChF,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAElE,OAAO,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAG5D,SAAS,KAAK,CAAC,IAAoC,EAAE,UAA+B;IAClF,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IACjC,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE;YACtB,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAClD,CAAC,CAAC,CAAC;IACL,CAAC;IACD,OAAO,IAAI;SACR,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CACX,GAAG;SACA,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE;QACf,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACxB,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAC/D,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC;SACV,OAAO,EAAE,CACb;SACA,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,SAAS,CAAC,IAAY;IACpC,4CAA4C;IAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,gCAAgC,EAAE,CAAC,CAAC,EAAE,EAAE,CAC1D,MAAM,CAAC,CAAC,WAAW,CAAC,CAAC,CAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CACxD,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,cAAc,CAAC,IAAY,EAAE,MAAM,GAAG,EAAE;IACtD,OAAO,IAAI;SACR,KAAK,CAAC,IAAI,CAAC;SACX,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;SACnE,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC;AAED,0FAA0F;AAC1F,MAAM,UAAU,UAAU,CAAC,IAAa,EAAE,IAAoB;IAC5D,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IACxB,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,KAAK,CAAC,IAAI,CAAC,cAAc,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;IACtC,KAAK,CAAC,IAAI,CAAC,cAAc,cAAc,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACnD,KAAK,CAAC,IAAI,CACR,cACE,eAAe,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC;QACxD,GAAG,SAAS,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,SAAS,CAAC,MAAM,CAAC,YAAY,CAAC,gBACrE,EAAE,CACH,CAAC;IACF,KAAK,CAAC,IAAI,CACR,cAAc,cAAc,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,IAAI,CAAC,WAAW,eAAe,MAAM,CAAC,cAAc,IAAI,CACjH,CAAC;IACF,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,mBAAmB,GAAG,IAAI,CAAC,KAAK,CAAC,qBAAqB,CAAC;IACtF,IAAI,IAAI,CAAC,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,IAAI,EAAE,CAAC;QACxD,KAAK,CAAC,IAAI,CAAC,cAAc,cAAc,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAAC;IACtF,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,cAAc,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IACvD,IAAI,MAAM,CAAC,SAAS;QAAE,KAAK,CAAC,IAAI,CAAC,cAAc,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IAC9E,IAAI,MAAM,CAAC,WAAW;QAAE,KAAK,CAAC,IAAI,CAAC,cAAc,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IAElF,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC;IACjC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,sFAAsF;IACtF,gFAAgF;IAChF,MAAM,eAAe,GAAG,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC;IACtD,MAAM,cAAc,GAClB,eAAe,GAAG,CAAC;QACjB,CAAC,CAAC,MAAM,eAAe,sBAAsB,eAAe,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE;QAC/E,CAAC,CAAC,EAAE,CAAC;IACT,KAAK,CAAC,IAAI,CACR,cAAc,OAAO,CAAC,MAAM,UAAU,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,cAAc,EAAE,CACzF,CAAC;IACF,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,MAAM,IAAI,GAAe,CAAC,CAAC,GAAG,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;IACvF,MAAM,OAAO,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC1C,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QAChC,KAAK,MAAM,OAAO,IAAI,KAAK,CAAC,QAAQ;YAAE,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC1F,CAAC;IACD,sFAAsF;IACtF,wFAAwF;IACxF,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;IAC3E,KAAK,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;QAC9C,IAAI,CAAC,IAAI,CAAC;YACR,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;YACpB,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;YACnD,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC;YACvB,SAAS,CAAC,MAAM,CAAC,iBAAiB,CAAC;YACnC,GAAG,QAAQ,CAAC,GAAG,CAAC,KAAK;YACrB,GAAG,MAAM,CAAC,WAAW,OAAO,MAAM,CAAC,WAAW,EAAE;YAChD;;;;;;cAME;YACF,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC;gBACvB,CAAC,MAAM,CAAC,gBAAgB,KAAK,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,gBAAgB,CAAC;SACtE,CAAC,CAAC;IACL,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAEtC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3B,KAAK,CAAC,IAAI,CACR,IAAI,CAAC,MAAM,KAAK,MAAM;YACpB,CAAC,CAAC,qFAAqF;gBACrF,2EAA2E;YAC7E,CAAC,CAAC,qDAAqD,IAAI,CAAC,MAAM,CAAC,MAAM,wBAAwB;gBAC/F,0BAA0B,CAC/B,CAAC;IACJ,CAAC;IACD;;;;;;;;;;;;MAYE;IACF,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;QACvB,sFAAsF;QACtF,wEAAwE;QACxE,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC;QAC9C,KAAK,CAAC,IAAI,CACR,IAAI,CAAC,iBAAiB,CAAC,MAAM,GAAG,CAAC;YAC/B,CAAC,CAAC,0BAA0B,MAAM,gBAAgB,MAAM,4BAA4B;gBAClF,uDAAuD;YACzD,CAAC,CAAC,uBAAuB,MAAM,2CAA2C,MAAM,GAAG;gBACjF,yDAAyD,CAC9D,CAAC;QACF,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAED,uFAAuF;IACvF,yFAAyF;IACzF,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC;IAC9B,KAAK,CAAC,IAAI,CACR,eAAe,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,iBAAiB;QACxE,GAAG,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,GAAG,CACpF,CAAC;IAEF,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,QAAQ,CAAC,IAAa,EAAE,IAAoB,EAAE,SAAwB,CAAC;IACrF,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IACxB,MAAM,OAAO,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC1C,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QAChC,KAAK,MAAM,OAAO,IAAI,KAAK,CAAC,QAAQ;YAAE,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC1F,CAAC;IAED,OAAO,IAAI,CAAC,SAAS,CACnB;QACE,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,KAAK,EAAE,IAAI,CAAC,QAAQ;QACpB,MAAM,EAAE,cAAc,CAAC,MAAM,CAAC;QAC9B,oBAAoB,EAAE,eAAe,CAAC,MAAM,CAAC,aAAa,CAAC;QAC3D,cAAc,EAAE,MAAM,CAAC,YAAY;QACnC,cAAc,EAAE,MAAM,CAAC,YAAY;QACnC,UAAU,EAAE,MAAM,CAAC,SAAS;QAC5B,YAAY,EAAE,MAAM,CAAC,WAAW;QAChC,YAAY,EAAE,IAAI,CAAC,WAAW;QAC9B,qBAAqB,EAAE,MAAM,CAAC,mBAAmB;QACjD,uBAAuB,EAAE,MAAM,CAAC,cAAc;QAC9C,gBAAgB,EAAE,IAAI,CAAC,eAAe;QACtC,oFAAoF;QACpF,iBAAiB,EAAE,IAAI,CAAC,KAAK,CAAC,mBAAmB,GAAG,IAAI,CAAC,KAAK,CAAC,qBAAqB;QACpF,mBAAmB,EAAE,IAAI,CAAC,iBAAiB,CAAC,MAAM;QAClD,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YAC1C,YAAY,EAAE,MAAM,CAAC,KAAK;YAC1B,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE;YAChD,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,IAAI,EAAE,MAAM,CAAC,iBAAiB;YAC9B,gBAAgB,EAAE,MAAM,CAAC,YAAY;YACrC,kBAAkB,EAAE,MAAM,CAAC,gBAAgB;YAC3C,YAAY,EAAE,MAAM,CAAC,WAAW;YAChC,YAAY,EAAE,MAAM,CAAC,WAAW;YAChC,WAAW,EAAE,MAAM,CAAC,UAAU;YAC9B,WAAW,EAAE,MAAM,CAAC,UAAU;YAC9B,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,WAAW,EAAE,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,IAAI;SAC/C,CAAC,CAAC;QACH,QAAQ,EAAE;YACR,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI;YACxB,iFAAiF;YACjF,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK;YAC1B,yBAAyB,EAAE,IAAI,CAAC,QAAQ,CAAC,uBAAuB;SACjE;QACD,oFAAoF;QACpF,sFAAsF;QACtF,iFAAiF;QACjF,uFAAuF;QACvF,QAAQ,EAAE,IAAI,CAAC,WAAW;aACvB,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;aAChD,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;KAC5E,EACD,IAAI,EACJ,MAAM,IAAI,SAAS,CACpB,CAAC;AACJ,CAAC;AAED,mEAAmE;AACnE,MAAM,UAAU,iBAAiB,CAAC,WAAkC;IAClE,OAAO,WAAW;SACf,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QACT,+EAA+E;QAC/E,sCAAsC;QACtC,MAAM,IAAI,GAAG,GAAG,CAAC,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;QACzF,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,cAAc,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;IAClE,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,MAAqB;IACjD,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,MAAM,IAAI,GAAe,EAAE,CAAC;IAC5B,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QAChC,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC7G,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,SAAS,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;IACxC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACtC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAChE,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,MAAqB,EAAE,SAAwB,CAAC;IAC1E,OAAO,IAAI,CAAC,SAAS,CACnB;QACE,UAAU,EAAE,MAAM,CAAC,SAAS;QAC5B,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,WAAW,EAAE,MAAM,CAAC,eAAe;QACnC,gBAAgB,EAAE,MAAM,CAAC,IAAI,CAAC,eAAe;QAC7C,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,WAAW;QAChC,UAAU,EAAE,MAAM,CAAC,SAAS;QAC5B,QAAQ,EAAE,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;KACtG,EACD,IAAI,EACJ,MAAM,IAAI,SAAS,CACpB,CAAC;AACJ,CAAC","sourcesContent":["/**\n * Human-readable output for the terminal.\n *\n * Everything here is plain text with no colour codes, so piping to a file or a log\n * produces exactly what appeared on screen.\n */\n\nimport type { Diagnostic } from '../edf/errors.js';\nimport type { EdfFile } from '../edf/reader.js';\nimport { describeFormat, formatRates, formatWallClock } from '../edf/header.js';\nimport { formatBytes, formatDuration } from '../format/number.js';\nimport type { ConversionPlan } from '../convert/plan.js';\nimport { withoutFileRateWarning } from '../convert/plan.js';\nimport type { ConvertResult } from '../convert/run.js';\n\nfunction table(rows: readonly (readonly string[])[], alignRight: ReadonlySet<number>): string {\n  if (rows.length === 0) return '';\n  const width: number[] = [];\n  for (const row of rows) {\n    row.forEach((cell, i) => {\n      width[i] = Math.max(width[i] ?? 0, cell.length);\n    });\n  }\n  return rows\n    .map((row) =>\n      row\n        .map((cell, i) => {\n          const w = width[i] ?? 0;\n          return alignRight.has(i) ? cell.padStart(w) : cell.padEnd(w);\n        })\n        .join('  ')\n        .trimEnd(),\n    )\n    .join('\\n');\n}\n\n/**\n * Make header text safe to print to a terminal.\n *\n * EDF identification fields and channel labels are free text copied verbatim out of the\n * file, and `--info` puts them straight on stdout. A header carrying ANSI escapes could\n * therefore drive the reader's terminal — `\\x1b[2J\\x1b[H` clears the screen and homes the\n * cursor, which is enough to hide the rest of the output or repaint it as something else.\n * Nobody writes an EDF header that way on purpose, which is exactly why a file that does\n * should not be trusted with the terminal.\n *\n * Control bytes are shown as their escape instead, so a corrupt field stays diagnosable\n * rather than being silently swallowed. This affects display only: `channels.csv` and\n * `metadata.json` still copy the field verbatim, and CSV quoting already makes that safe.\n */\nexport function printable(text: string): string {\n  // eslint-disable-next-line no-control-regex\n  return text.replace(/[\\u0000-\\u001f\\u007f-\\u009f]/gu, (c) =>\n    `\\\\x${c.codePointAt(0)!.toString(16).padStart(2, '0')}`,\n  );\n}\n\n/**\n * The same protection for text that is meant to span lines.\n *\n * `printable` escapes newlines along with everything else, which is right for a channel\n * label — one has no business containing a line break, and it would break the `--info`\n * table's alignment. It is wrong for a whole message: several are written on two lines,\n * and Node's own option errors run to three. Escaping those turned the break into text:\n *\n *     error: No channel named \"ECQ\". Did you mean \"ECG\"?\\x0aRun with --info to list ...\n *\n * Each line is escaped on its own, so nothing here gains the ability to drive a terminal.\n * A carriage return is still escaped, so no line can be repainted after it is printed —\n * which is the property that mattered. A newline can only add a line, never overwrite one.\n */\nexport function printableLines(text: string, indent = ''): string {\n  return text\n    .split('\\n')\n    .map((line, index) => (index === 0 ? '' : indent) + printable(line))\n    .join('\\n');\n}\n\n/** The `--info` view: what is in this recording, and what would converting it produce. */\nexport function formatInfo(file: EdfFile, plan: ConversionPlan): string {\n  const { header } = file;\n  const lines: string[] = [];\n\n  lines.push(`File       ${file.path}`);\n  lines.push(`Format     ${describeFormat(header)}`);\n  lines.push(\n    `Recorded   ${\n      formatWallClock(header.startDateTime)?.replace('T', ' ') ??\n      `${printable(header.startDateRaw)} ${printable(header.startTimeRaw)} (unparseable)`\n    }`,\n  );\n  lines.push(\n    `Duration   ${formatDuration(file.durationSeconds)}  (${file.recordCount} records of ${header.recordDuration}s)`,\n  );\n  const elapsedSpan = plan.range.recordingEndSeconds - plan.range.recordingStartSeconds;\n  if (Math.abs(elapsedSpan - file.durationSeconds) > 1e-9) {\n    lines.push(`Time span  ${formatDuration(elapsedSpan)}  (includes discontinuities)`);\n  }\n  lines.push(`Size       ${formatBytes(file.fileSize)}`);\n  if (header.patientId) lines.push(`Patient    ${printable(header.patientId)}`);\n  if (header.recordingId) lines.push(`Recording  ${printable(header.recordingId)}`);\n\n  const signals = file.dataSignals;\n  lines.push('');\n  // The signal count was pluralised but the annotation-channel count was not, so a file\n  // carrying two of them read \"2 annotation channel\". EDF+ permits more than one.\n  const annotationCount = file.annotationSignals.length;\n  const annotationPart =\n    annotationCount > 0\n      ? ` + ${annotationCount} annotation channel${annotationCount === 1 ? '' : 's'}`\n      : '';\n  lines.push(\n    `Channels   ${signals.length} signal${signals.length === 1 ? '' : 's'}${annotationPart}`,\n  );\n  lines.push('');\n\n  const rows: string[][] = [['#', 'COLUMN', 'LABEL', 'UNIT', 'RATE', 'RANGE', 'OUTPUT']];\n  const fileFor = new Map<number, string>();\n  for (const group of plan.groups) {\n    for (const channel of group.channels) fileFor.set(channel.signal.index, group.fileName);\n  }\n  // Rendered as a group so that two channels recorded at different rates never show the\n  // same figure in the RATE column, which is the one thing this table is asked to settle.\n  const rateText = formatRates(signals.map((signal) => signal.samplingRate));\n  for (const [row, signal] of signals.entries()) {\n    rows.push([\n      String(signal.index),\n      printable(plan.columnNames.get(signal.index) ?? ''),\n      printable(signal.label),\n      printable(signal.physicalDimension),\n      `${rateText[row]} Hz`,\n      `${signal.physicalMin} to ${signal.physicalMax}`,\n      /*\n        A channel with no samples was reported as \"(not selected)\", which is a different\n        thing and not true when it was named on --channels. `edf2csv rec.edf --info\n        --channels unused` said the channel the command asked for had not been chosen, when\n        what is actually the case is that the file gives it nothing to convert. The\n        NO_SAMPLES warning below the table says so; the table contradicted it.\n      */\n      fileFor.get(signal.index) ??\n        (signal.samplesPerRecord === 0 ? '(no samples)' : '(not selected)'),\n    ]);\n  }\n  lines.push(table(rows, new Set([0])));\n\n  lines.push('');\n  if (plan.groups.length > 1) {\n    lines.push(\n      plan.layout === 'long'\n        ? `Sampling rates differ, and the long layout puts them in one table anyway: each row ` +\n          `carries its own time, so nothing has to line up. No channel is resampled.`\n        : `Sampling rates differ, so channels are written to ${plan.groups.length} files, one per rate. ` +\n          `No channel is resampled.`,\n    );\n  }\n  /*\n    The estimate describes the signal tables, and says so when that is not what will be\n    written.\n\n    Under --annotations-only there are no signal tables, and the line read \"Would write 0\n    rows, roughly 0 B.\" for a conversion that goes on to write annotations.csv with three\n    events in it. --info exists to say what a conversion will do; asserting it will write\n    nothing, when it will write a file, is the one thing it must not do.\n\n    How many events there are cannot be answered from the header — the annotation channel has\n    to be read record by record, which is the scan --info is for avoiding. So it says which\n    file, and that the count is not knowable this cheaply, rather than inventing a zero.\n  */\n  if (!plan.writeSignals) {\n    // Named as they will be written. --info is read to find out what a run leaves behind,\n    // and a script that opens the name it was given must find a file there.\n    const suffix = plan.gzip ? '.csv.gz' : '.csv';\n    lines.push(\n      file.annotationSignals.length > 0\n        ? `Would write annotations${suffix} and channels${suffix}, and no signal data. How ` +\n          'many events there are cannot be told from the header.'\n        : `Would write channels${suffix} and no signal data — and no annotations${suffix} ` +\n          'either, since this recording has no annotation channel.',\n    );\n    return lines.join('\\n');\n  }\n\n  // The estimate counts the characters of the CSV, which is what --gzip then compresses.\n  // Reporting it as the size on disk would overstate a compressed conversion several-fold.\n  const compressing = plan.gzip;\n  lines.push(\n    `Would write ${plan.estimate.rows.toLocaleString('en-US')} rows, roughly ` +\n      `${formatBytes(plan.estimate.bytes)}${compressing ? ' before compression' : ''}.`,\n  );\n\n  return lines.join('\\n');\n}\n\n/**\n * The `--info` view as JSON, for surveying files from a script.\n *\n * `indent` is 2 for a single recording, matching what this has always printed, and null for\n * a batch — several pretty-printed documents run together are readable by a streaming parser\n * but not by anything that expects one record per line, and a batch is exactly where\n * line-oriented reading is wanted. null rather than undefined because a default parameter\n * takes effect when undefined is passed, which quietly restored the indentation this was\n * meant to drop; JSON.stringify itself wants undefined, so it is translated at the call.\n *\n * `--info` answers \"what is in this recording and what would converting it cost\", which\n * is exactly the question you want to ask across a directory of hundreds of recordings —\n * and the text table is the wrong shape for that. `--json` previously applied only to\n * conversions, so scripts had to parse the aligned columns or convert files just to learn\n * what was in them.\n *\n * Field names match `metadata.json` where the two describe the same thing, so a survey and\n * a conversion can be read by the same code.\n */\nexport function infoJson(file: EdfFile, plan: ConversionPlan, indent: number | null = 2): string {\n  const { header } = file;\n  const fileFor = new Map<number, string>();\n  for (const group of plan.groups) {\n    for (const channel of group.channels) fileFor.set(channel.signal.index, group.fileName);\n  }\n\n  return JSON.stringify(\n    {\n      path: file.path,\n      bytes: file.fileSize,\n      format: describeFormat(header),\n      start_datetime_local: formatWallClock(header.startDateTime),\n      start_date_raw: header.startDateRaw,\n      start_time_raw: header.startTimeRaw,\n      patient_id: header.patientId,\n      recording_id: header.recordingId,\n      data_records: file.recordCount,\n      data_records_declared: header.declaredRecordCount,\n      record_duration_seconds: header.recordDuration,\n      duration_seconds: file.durationSeconds,\n      // For a discontinuous file this exceeds duration_seconds by the length of the gaps.\n      time_span_seconds: plan.range.recordingEndSeconds - plan.range.recordingStartSeconds,\n      annotation_channels: file.annotationSignals.length,\n      channels: file.dataSignals.map((signal) => ({\n        signal_index: signal.index,\n        column: plan.columnNames.get(signal.index) ?? '',\n        label: signal.label,\n        unit: signal.physicalDimension,\n        sampling_rate_hz: signal.samplingRate,\n        samples_per_record: signal.samplesPerRecord,\n        physical_min: signal.physicalMin,\n        physical_max: signal.physicalMax,\n        digital_min: signal.digitalMin,\n        digital_max: signal.digitalMax,\n        transducer: signal.transducer,\n        prefiltering: signal.prefiltering,\n        output_file: fileFor.get(signal.index) ?? null,\n      })),\n      estimate: {\n        rows: plan.estimate.rows,\n        // Character count of the CSV. With --gzip the file on disk is smaller than this.\n        bytes: plan.estimate.bytes,\n        exceeds_spreadsheet_limit: plan.estimate.exceedsSpreadsheetLimit,\n      },\n      // The plan's mixed-rate warning replaces the header parser's, as it does everywhere\n      // else. This was the one consumer left out of that when 0.3.2 made the warning follow\n      // --channels, so `--info --json` carried it twice: once counting the rates being\n      // converted and once counting every rate in the file, with the same code and severity.\n      warnings: plan.diagnostics\n        .concat(withoutFileRateWarning(file.diagnostics))\n        .map((d) => ({ code: d.code, severity: d.severity, message: d.message })),\n    },\n    null,\n    indent ?? undefined,\n  );\n}\n\n/** One line per diagnostic, prefixed so warnings are greppable. */\nexport function formatDiagnostics(diagnostics: readonly Diagnostic[]): string {\n  return diagnostics\n    .map((d) => {\n      // Diagnostics quote channel labels, which come from the file, so they need the\n      // same treatment as the --info table.\n      const head = `${d.severity === 'warning' ? 'warning' : 'note'}: ${printable(d.message)}`;\n      return d.hint ? `${head}\\n         ${printable(d.hint)}` : head;\n    })\n    .join('\\n');\n}\n\nexport function formatSummary(result: ConvertResult): string {\n  const lines: string[] = [];\n  const rows: string[][] = [];\n  for (const file of result.files) {\n    rows.push([`  ${file.name}`, file.rows.toLocaleString('en-US'), file.name.endsWith('.csv') ? 'rows' : '']);\n  }\n  lines.push(`Wrote ${result.outputDir}`);\n  lines.push(table(rows, new Set([1])));\n  lines.push(`Done in ${(result.elapsedMs / 1000).toFixed(1)}s.`);\n  return lines.join('\\n');\n}\n\nexport function summaryJson(result: ConvertResult, indent: number | null = 2): string {\n  return JSON.stringify(\n    {\n      output_dir: result.outputDir,\n      files: result.files,\n      annotations: result.annotationCount,\n      duration_seconds: result.file.durationSeconds,\n      records: result.file.recordCount,\n      elapsed_ms: result.elapsedMs,\n      warnings: result.diagnostics.map((d) => ({ code: d.code, severity: d.severity, message: d.message })),\n    },\n    null,\n    indent ?? undefined,\n  );\n}\n"]}
+{"version":3,"file":"report.js","sourceRoot":"","sources":["../../src/cli/report.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAChF,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAElE,OAAO,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAG5D,SAAS,KAAK,CAAC,IAAoC,EAAE,UAA+B;IAClF,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IACjC,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE;YACtB,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAClD,CAAC,CAAC,CAAC;IACL,CAAC;IACD,OAAO,IAAI;SACR,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CACX,GAAG;SACA,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE;QACf,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACxB,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAC/D,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC;SACV,OAAO,EAAE,CACb;SACA,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,SAAS,CAAC,IAAY;IACpC,4CAA4C;IAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,gCAAgC,EAAE,CAAC,CAAC,EAAE,EAAE,CAC1D,MAAM,CAAC,CAAC,WAAW,CAAC,CAAC,CAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CACxD,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,cAAc,CAAC,IAAY,EAAE,MAAM,GAAG,EAAE;IACtD,OAAO,IAAI;SACR,KAAK,CAAC,IAAI,CAAC;SACX,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;SACnE,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC;AAED,0FAA0F;AAC1F,MAAM,UAAU,UAAU,CAAC,IAAa,EAAE,IAAoB;IAC5D,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IACxB,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,KAAK,CAAC,IAAI,CAAC,cAAc,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;IACtC,KAAK,CAAC,IAAI,CAAC,cAAc,cAAc,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACnD,KAAK,CAAC,IAAI,CACR,cACE,eAAe,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC;QACxD,GAAG,SAAS,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,SAAS,CAAC,MAAM,CAAC,YAAY,CAAC,gBACrE,EAAE,CACH,CAAC;IACF,KAAK,CAAC,IAAI,CACR,cAAc,cAAc,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,IAAI,CAAC,WAAW,eAAe,MAAM,CAAC,cAAc,IAAI,CACjH,CAAC;IACF,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,mBAAmB,GAAG,IAAI,CAAC,KAAK,CAAC,qBAAqB,CAAC;IACtF,IAAI,IAAI,CAAC,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,IAAI,EAAE,CAAC;QACxD,KAAK,CAAC,IAAI,CAAC,cAAc,cAAc,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAAC;IACtF,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,cAAc,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IACvD,IAAI,MAAM,CAAC,SAAS;QAAE,KAAK,CAAC,IAAI,CAAC,cAAc,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IAC9E,IAAI,MAAM,CAAC,WAAW;QAAE,KAAK,CAAC,IAAI,CAAC,cAAc,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IAElF,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC;IACjC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,sFAAsF;IACtF,gFAAgF;IAChF,MAAM,eAAe,GAAG,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC;IACtD,MAAM,cAAc,GAClB,eAAe,GAAG,CAAC;QACjB,CAAC,CAAC,MAAM,eAAe,sBAAsB,eAAe,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE;QAC/E,CAAC,CAAC,EAAE,CAAC;IACT,KAAK,CAAC,IAAI,CACR,cAAc,OAAO,CAAC,MAAM,UAAU,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,cAAc,EAAE,CACzF,CAAC;IACF,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,MAAM,IAAI,GAAe,CAAC,CAAC,GAAG,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;IACvF,MAAM,OAAO,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC1C,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QAChC,KAAK,MAAM,OAAO,IAAI,KAAK,CAAC,QAAQ;YAAE,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC1F,CAAC;IACD,sFAAsF;IACtF,wFAAwF;IACxF,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;IAC3E,KAAK,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;QAC9C,IAAI,CAAC,IAAI,CAAC;YACR,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;YACpB,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;YACnD,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC;YACvB,SAAS,CAAC,MAAM,CAAC,iBAAiB,CAAC;YACnC,GAAG,QAAQ,CAAC,GAAG,CAAC,KAAK;YACrB,GAAG,MAAM,CAAC,WAAW,OAAO,MAAM,CAAC,WAAW,EAAE;YAChD;;;;;;cAME;YACF,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC;gBACvB,CAAC,MAAM,CAAC,gBAAgB,KAAK,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,gBAAgB,CAAC;SACtE,CAAC,CAAC;IACL,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAEtC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3B,KAAK,CAAC,IAAI,CACR,IAAI,CAAC,MAAM,KAAK,MAAM;YACpB,CAAC,CAAC,qFAAqF;gBACrF,2EAA2E;YAC7E,CAAC,CAAC,qDAAqD,IAAI,CAAC,MAAM,CAAC,MAAM,wBAAwB;gBAC/F,0BAA0B,CAC/B,CAAC;IACJ,CAAC;IACD;;;;;;;;;;;;MAYE;IACF,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;QACvB,sFAAsF;QACtF,wEAAwE;QACxE,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC;QAC9C,KAAK,CAAC,IAAI,CACR,IAAI,CAAC,iBAAiB,CAAC,MAAM,GAAG,CAAC;YAC/B,CAAC,CAAC,0BAA0B,MAAM,gBAAgB,MAAM,4BAA4B;gBAClF,uDAAuD;YACzD,CAAC,CAAC,uBAAuB,MAAM,2CAA2C,MAAM,GAAG;gBACjF,yDAAyD,CAC9D,CAAC;QACF,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAED,uFAAuF;IACvF,yFAAyF;IACzF,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC;IAC9B,KAAK,CAAC,IAAI,CACR,eAAe,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,iBAAiB;QACxE,GAAG,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,GAAG,CACpF,CAAC;IAEF,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,QAAQ,CAAC,IAAa,EAAE,IAAoB,EAAE,SAAwB,CAAC;IACrF,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IACxB,MAAM,OAAO,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC1C,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QAChC,KAAK,MAAM,OAAO,IAAI,KAAK,CAAC,QAAQ;YAAE,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC1F,CAAC;IAED,OAAO,IAAI,CAAC,SAAS,CACnB;QACE,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,KAAK,EAAE,IAAI,CAAC,QAAQ;QACpB,MAAM,EAAE,cAAc,CAAC,MAAM,CAAC;QAC9B,oBAAoB,EAAE,eAAe,CAAC,MAAM,CAAC,aAAa,CAAC;QAC3D,cAAc,EAAE,MAAM,CAAC,YAAY;QACnC,cAAc,EAAE,MAAM,CAAC,YAAY;QACnC,UAAU,EAAE,MAAM,CAAC,SAAS;QAC5B,YAAY,EAAE,MAAM,CAAC,WAAW;QAChC,YAAY,EAAE,IAAI,CAAC,WAAW;QAC9B,qBAAqB,EAAE,MAAM,CAAC,mBAAmB;QACjD,uBAAuB,EAAE,MAAM,CAAC,cAAc;QAC9C,gBAAgB,EAAE,IAAI,CAAC,eAAe;QACtC,oFAAoF;QACpF,iBAAiB,EAAE,IAAI,CAAC,KAAK,CAAC,mBAAmB,GAAG,IAAI,CAAC,KAAK,CAAC,qBAAqB;QACpF,mBAAmB,EAAE,IAAI,CAAC,iBAAiB,CAAC,MAAM;QAClD,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YAC1C,YAAY,EAAE,MAAM,CAAC,KAAK;YAC1B,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE;YAChD,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,IAAI,EAAE,MAAM,CAAC,iBAAiB;YAC9B,gBAAgB,EAAE,MAAM,CAAC,YAAY;YACrC,kBAAkB,EAAE,MAAM,CAAC,gBAAgB;YAC3C,YAAY,EAAE,MAAM,CAAC,WAAW;YAChC,YAAY,EAAE,MAAM,CAAC,WAAW;YAChC,WAAW,EAAE,MAAM,CAAC,UAAU;YAC9B,WAAW,EAAE,MAAM,CAAC,UAAU;YAC9B,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,WAAW,EAAE,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,IAAI;SAC/C,CAAC,CAAC;QACH,QAAQ,EAAE;YACR,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI;YACxB,iFAAiF;YACjF,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK;YAC1B,yBAAyB,EAAE,IAAI,CAAC,QAAQ,CAAC,uBAAuB;SACjE;QACD,oFAAoF;QACpF,sFAAsF;QACtF,iFAAiF;QACjF,uFAAuF;QACvF,QAAQ,EAAE,IAAI,CAAC,WAAW;aACvB,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;aAChD,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;KAC5E,EACD,IAAI,EACJ,MAAM,IAAI,SAAS,CACpB,CAAC;AACJ,CAAC;AAED,mEAAmE;AACnE,MAAM,UAAU,iBAAiB,CAAC,WAAkC;IAClE,OAAO,WAAW;SACf,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QACT,+EAA+E;QAC/E,sCAAsC;QACtC,MAAM,IAAI,GAAG,GAAG,CAAC,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;QACzF,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,cAAc,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;IAClE,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,MAAqB;IACjD,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,MAAM,IAAI,GAAe,EAAE,CAAC;IAC5B,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QAChC,qFAAqF;QACrF,+EAA+E;QAC/E,IAAI,CAAC,IAAI,CAAC;YACR,KAAK,IAAI,CAAC,IAAI,EAAE;YAChB,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC;YACjC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE;SAC/C,CAAC,CAAC;IACL,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,SAAS,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;IACxC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACtC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAChE,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,MAAqB,EAAE,SAAwB,CAAC;IAC1E,OAAO,IAAI,CAAC,SAAS,CACnB;QACE,UAAU,EAAE,MAAM,CAAC,SAAS;QAC5B,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,WAAW,EAAE,MAAM,CAAC,eAAe;QACnC,gBAAgB,EAAE,MAAM,CAAC,IAAI,CAAC,eAAe;QAC7C,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,WAAW;QAChC,UAAU,EAAE,MAAM,CAAC,SAAS;QAC5B,QAAQ,EAAE,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;KACtG,EACD,IAAI,EACJ,MAAM,IAAI,SAAS,CACpB,CAAC;AACJ,CAAC","sourcesContent":["/**\n * Human-readable output for the terminal.\n *\n * Everything here is plain text with no colour codes, so piping to a file or a log\n * produces exactly what appeared on screen.\n */\n\nimport type { Diagnostic } from '../edf/errors.js';\nimport type { EdfFile } from '../edf/reader.js';\nimport { describeFormat, formatRates, formatWallClock } from '../edf/header.js';\nimport { formatBytes, formatDuration } from '../format/number.js';\nimport type { ConversionPlan } from '../convert/plan.js';\nimport { withoutFileRateWarning } from '../convert/plan.js';\nimport type { ConvertResult } from '../convert/run.js';\n\nfunction table(rows: readonly (readonly string[])[], alignRight: ReadonlySet<number>): string {\n  if (rows.length === 0) return '';\n  const width: number[] = [];\n  for (const row of rows) {\n    row.forEach((cell, i) => {\n      width[i] = Math.max(width[i] ?? 0, cell.length);\n    });\n  }\n  return rows\n    .map((row) =>\n      row\n        .map((cell, i) => {\n          const w = width[i] ?? 0;\n          return alignRight.has(i) ? cell.padStart(w) : cell.padEnd(w);\n        })\n        .join('  ')\n        .trimEnd(),\n    )\n    .join('\\n');\n}\n\n/**\n * Make header text safe to print to a terminal.\n *\n * EDF identification fields and channel labels are free text copied verbatim out of the\n * file, and `--info` puts them straight on stdout. A header carrying ANSI escapes could\n * therefore drive the reader's terminal — `\\x1b[2J\\x1b[H` clears the screen and homes the\n * cursor, which is enough to hide the rest of the output or repaint it as something else.\n * Nobody writes an EDF header that way on purpose, which is exactly why a file that does\n * should not be trusted with the terminal.\n *\n * Control bytes are shown as their escape instead, so a corrupt field stays diagnosable\n * rather than being silently swallowed. This affects display only: `channels.csv` and\n * `metadata.json` still copy the field verbatim, and CSV quoting already makes that safe.\n */\nexport function printable(text: string): string {\n  // eslint-disable-next-line no-control-regex\n  return text.replace(/[\\u0000-\\u001f\\u007f-\\u009f]/gu, (c) =>\n    `\\\\x${c.codePointAt(0)!.toString(16).padStart(2, '0')}`,\n  );\n}\n\n/**\n * The same protection for text that is meant to span lines.\n *\n * `printable` escapes newlines along with everything else, which is right for a channel\n * label — one has no business containing a line break, and it would break the `--info`\n * table's alignment. It is wrong for a whole message: several are written on two lines,\n * and Node's own option errors run to three. Escaping those turned the break into text:\n *\n *     error: No channel named \"ECQ\". Did you mean \"ECG\"?\\x0aRun with --info to list ...\n *\n * Each line is escaped on its own, so nothing here gains the ability to drive a terminal.\n * A carriage return is still escaped, so no line can be repainted after it is printed —\n * which is the property that mattered. A newline can only add a line, never overwrite one.\n */\nexport function printableLines(text: string, indent = ''): string {\n  return text\n    .split('\\n')\n    .map((line, index) => (index === 0 ? '' : indent) + printable(line))\n    .join('\\n');\n}\n\n/** The `--info` view: what is in this recording, and what would converting it produce. */\nexport function formatInfo(file: EdfFile, plan: ConversionPlan): string {\n  const { header } = file;\n  const lines: string[] = [];\n\n  lines.push(`File       ${file.path}`);\n  lines.push(`Format     ${describeFormat(header)}`);\n  lines.push(\n    `Recorded   ${\n      formatWallClock(header.startDateTime)?.replace('T', ' ') ??\n      `${printable(header.startDateRaw)} ${printable(header.startTimeRaw)} (unparseable)`\n    }`,\n  );\n  lines.push(\n    `Duration   ${formatDuration(file.durationSeconds)}  (${file.recordCount} records of ${header.recordDuration}s)`,\n  );\n  const elapsedSpan = plan.range.recordingEndSeconds - plan.range.recordingStartSeconds;\n  if (Math.abs(elapsedSpan - file.durationSeconds) > 1e-9) {\n    lines.push(`Time span  ${formatDuration(elapsedSpan)}  (includes discontinuities)`);\n  }\n  lines.push(`Size       ${formatBytes(file.fileSize)}`);\n  if (header.patientId) lines.push(`Patient    ${printable(header.patientId)}`);\n  if (header.recordingId) lines.push(`Recording  ${printable(header.recordingId)}`);\n\n  const signals = file.dataSignals;\n  lines.push('');\n  // The signal count was pluralised but the annotation-channel count was not, so a file\n  // carrying two of them read \"2 annotation channel\". EDF+ permits more than one.\n  const annotationCount = file.annotationSignals.length;\n  const annotationPart =\n    annotationCount > 0\n      ? ` + ${annotationCount} annotation channel${annotationCount === 1 ? '' : 's'}`\n      : '';\n  lines.push(\n    `Channels   ${signals.length} signal${signals.length === 1 ? '' : 's'}${annotationPart}`,\n  );\n  lines.push('');\n\n  const rows: string[][] = [['#', 'COLUMN', 'LABEL', 'UNIT', 'RATE', 'RANGE', 'OUTPUT']];\n  const fileFor = new Map<number, string>();\n  for (const group of plan.groups) {\n    for (const channel of group.channels) fileFor.set(channel.signal.index, group.fileName);\n  }\n  // Rendered as a group so that two channels recorded at different rates never show the\n  // same figure in the RATE column, which is the one thing this table is asked to settle.\n  const rateText = formatRates(signals.map((signal) => signal.samplingRate));\n  for (const [row, signal] of signals.entries()) {\n    rows.push([\n      String(signal.index),\n      printable(plan.columnNames.get(signal.index) ?? ''),\n      printable(signal.label),\n      printable(signal.physicalDimension),\n      `${rateText[row]} Hz`,\n      `${signal.physicalMin} to ${signal.physicalMax}`,\n      /*\n        A channel with no samples was reported as \"(not selected)\", which is a different\n        thing and not true when it was named on --channels. `edf2csv rec.edf --info\n        --channels unused` said the channel the command asked for had not been chosen, when\n        what is actually the case is that the file gives it nothing to convert. The\n        NO_SAMPLES warning below the table says so; the table contradicted it.\n      */\n      fileFor.get(signal.index) ??\n        (signal.samplesPerRecord === 0 ? '(no samples)' : '(not selected)'),\n    ]);\n  }\n  lines.push(table(rows, new Set([0])));\n\n  lines.push('');\n  if (plan.groups.length > 1) {\n    lines.push(\n      plan.layout === 'long'\n        ? `Sampling rates differ, and the long layout puts them in one table anyway: each row ` +\n          `carries its own time, so nothing has to line up. No channel is resampled.`\n        : `Sampling rates differ, so channels are written to ${plan.groups.length} files, one per rate. ` +\n          `No channel is resampled.`,\n    );\n  }\n  /*\n    The estimate describes the signal tables, and says so when that is not what will be\n    written.\n\n    Under --annotations-only there are no signal tables, and the line read \"Would write 0\n    rows, roughly 0 B.\" for a conversion that goes on to write annotations.csv with three\n    events in it. --info exists to say what a conversion will do; asserting it will write\n    nothing, when it will write a file, is the one thing it must not do.\n\n    How many events there are cannot be answered from the header — the annotation channel has\n    to be read record by record, which is the scan --info is for avoiding. So it says which\n    file, and that the count is not knowable this cheaply, rather than inventing a zero.\n  */\n  if (!plan.writeSignals) {\n    // Named as they will be written. --info is read to find out what a run leaves behind,\n    // and a script that opens the name it was given must find a file there.\n    const suffix = plan.gzip ? '.csv.gz' : '.csv';\n    lines.push(\n      file.annotationSignals.length > 0\n        ? `Would write annotations${suffix} and channels${suffix}, and no signal data. How ` +\n          'many events there are cannot be told from the header.'\n        : `Would write channels${suffix} and no signal data — and no annotations${suffix} ` +\n          'either, since this recording has no annotation channel.',\n    );\n    return lines.join('\\n');\n  }\n\n  // The estimate counts the characters of the CSV, which is what --gzip then compresses.\n  // Reporting it as the size on disk would overstate a compressed conversion several-fold.\n  const compressing = plan.gzip;\n  lines.push(\n    `Would write ${plan.estimate.rows.toLocaleString('en-US')} rows, roughly ` +\n      `${formatBytes(plan.estimate.bytes)}${compressing ? ' before compression' : ''}.`,\n  );\n\n  return lines.join('\\n');\n}\n\n/**\n * The `--info` view as JSON, for surveying files from a script.\n *\n * `indent` is 2 for a single recording, matching what this has always printed, and null for\n * a batch — several pretty-printed documents run together are readable by a streaming parser\n * but not by anything that expects one record per line, and a batch is exactly where\n * line-oriented reading is wanted. null rather than undefined because a default parameter\n * takes effect when undefined is passed, which quietly restored the indentation this was\n * meant to drop; JSON.stringify itself wants undefined, so it is translated at the call.\n *\n * `--info` answers \"what is in this recording and what would converting it cost\", which\n * is exactly the question you want to ask across a directory of hundreds of recordings —\n * and the text table is the wrong shape for that. `--json` previously applied only to\n * conversions, so scripts had to parse the aligned columns or convert files just to learn\n * what was in them.\n *\n * Field names match `metadata.json` where the two describe the same thing, so a survey and\n * a conversion can be read by the same code.\n */\nexport function infoJson(file: EdfFile, plan: ConversionPlan, indent: number | null = 2): string {\n  const { header } = file;\n  const fileFor = new Map<number, string>();\n  for (const group of plan.groups) {\n    for (const channel of group.channels) fileFor.set(channel.signal.index, group.fileName);\n  }\n\n  return JSON.stringify(\n    {\n      path: file.path,\n      bytes: file.fileSize,\n      format: describeFormat(header),\n      start_datetime_local: formatWallClock(header.startDateTime),\n      start_date_raw: header.startDateRaw,\n      start_time_raw: header.startTimeRaw,\n      patient_id: header.patientId,\n      recording_id: header.recordingId,\n      data_records: file.recordCount,\n      data_records_declared: header.declaredRecordCount,\n      record_duration_seconds: header.recordDuration,\n      duration_seconds: file.durationSeconds,\n      // For a discontinuous file this exceeds duration_seconds by the length of the gaps.\n      time_span_seconds: plan.range.recordingEndSeconds - plan.range.recordingStartSeconds,\n      annotation_channels: file.annotationSignals.length,\n      channels: file.dataSignals.map((signal) => ({\n        signal_index: signal.index,\n        column: plan.columnNames.get(signal.index) ?? '',\n        label: signal.label,\n        unit: signal.physicalDimension,\n        sampling_rate_hz: signal.samplingRate,\n        samples_per_record: signal.samplesPerRecord,\n        physical_min: signal.physicalMin,\n        physical_max: signal.physicalMax,\n        digital_min: signal.digitalMin,\n        digital_max: signal.digitalMax,\n        transducer: signal.transducer,\n        prefiltering: signal.prefiltering,\n        output_file: fileFor.get(signal.index) ?? null,\n      })),\n      estimate: {\n        rows: plan.estimate.rows,\n        // Character count of the CSV. With --gzip the file on disk is smaller than this.\n        bytes: plan.estimate.bytes,\n        exceeds_spreadsheet_limit: plan.estimate.exceedsSpreadsheetLimit,\n      },\n      // The plan's mixed-rate warning replaces the header parser's, as it does everywhere\n      // else. This was the one consumer left out of that when 0.3.2 made the warning follow\n      // --channels, so `--info --json` carried it twice: once counting the rates being\n      // converted and once counting every rate in the file, with the same code and severity.\n      warnings: plan.diagnostics\n        .concat(withoutFileRateWarning(file.diagnostics))\n        .map((d) => ({ code: d.code, severity: d.severity, message: d.message })),\n    },\n    null,\n    indent ?? undefined,\n  );\n}\n\n/** One line per diagnostic, prefixed so warnings are greppable. */\nexport function formatDiagnostics(diagnostics: readonly Diagnostic[]): string {\n  return diagnostics\n    .map((d) => {\n      // Diagnostics quote channel labels, which come from the file, so they need the\n      // same treatment as the --info table.\n      const head = `${d.severity === 'warning' ? 'warning' : 'note'}: ${printable(d.message)}`;\n      return d.hint ? `${head}\\n         ${printable(d.hint)}` : head;\n    })\n    .join('\\n');\n}\n\nexport function formatSummary(result: ConvertResult): string {\n  const lines: string[] = [];\n  const rows: string[][] = [];\n  for (const file of result.files) {\n    // `.csv.gz` is still a CSV, and its rows are still rows. The suffix test dropped the\n    // unit from every line of a --gzip summary, so the numbers stood on their own.\n    rows.push([\n      `  ${file.name}`,\n      file.rows.toLocaleString('en-US'),\n      /\\.csv(\\.gz)?$/u.test(file.name) ? 'rows' : '',\n    ]);\n  }\n  lines.push(`Wrote ${result.outputDir}`);\n  lines.push(table(rows, new Set([1])));\n  lines.push(`Done in ${(result.elapsedMs / 1000).toFixed(1)}s.`);\n  return lines.join('\\n');\n}\n\nexport function summaryJson(result: ConvertResult, indent: number | null = 2): string {\n  return JSON.stringify(\n    {\n      output_dir: result.outputDir,\n      files: result.files,\n      annotations: result.annotationCount,\n      duration_seconds: result.file.durationSeconds,\n      records: result.file.recordCount,\n      elapsed_ms: result.elapsedMs,\n      warnings: result.diagnostics.map((d) => ({ code: d.code, severity: d.severity, message: d.message })),\n    },\n    null,\n    indent ?? undefined,\n  );\n}\n"]}

package/dist/cli.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA;;;;;;;GAOG;AAeH,OAAO,EAA+C,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AA6HjG,wBAAsB,IAAI,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CA0WnE;AA2xBD,OAAO,EAAE,gBAAgB,EAAE,CAAC"}
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA;;;;;;;GAOG;AAeH,OAAO,EAA+C,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AA6HjG,wBAAsB,IAAI,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAkanE;AAyyBD,OAAO,EAAE,gBAAgB,EAAE,CAAC"}

package/dist/cli.js

@@ -57,7 +57,7 @@ Options
       --json             Print machine-readable JSON to stdout (works with --info too)
       --strict           Exit 1 if the recording raised any warning
       --stdout           Write the signal CSV to stdout instead of a directory
-                         (single-rate recordings only)
+                         (one table only: one sampling rate, or --layout long)
   -h, --help             Show this help
   -V, --version          Show the version
 
@@ -208,6 +208,24 @@ export async function main(argv) {
         process.stderr.write(`error: ${printable(entry)}: could not be read, so any recordings inside it were skipped.\n`);
     }
     if (expanded.length === 0) {
+        /*
+          "None here" and "could not look" are different answers, and so are their exit codes.
+    
+          A folder the process cannot read gave the same exit 2 and the same "No EDF or BDF
+          recordings found" as an empty one — while the line above it said the folder could not
+          be read. Exit 2 is this tool's code for "the command itself was wrong", so a script
+          was being told to fix its arguments when what needed fixing was a permission. The
+          command was fine; the filesystem refused.
+    
+          And the sentence itself claimed a fact the run is in no position to state: nothing was
+          found because nothing was looked at.
+        */
+        if (unreadable.length > 0) {
+            process.stderr.write(`Nothing could be converted: ${unreadable.length === 1 ? 'that path' : 'those paths'} ` +
+                `could not be read, so whether ${unreadable.length === 1 ? 'it holds' : 'they hold'} ` +
+                `recordings is unknown.\n`);
+            return EXIT_ERROR;
+        }
         process.stderr.write(`No EDF or BDF recordings found in ${listed(positionals.map((p) => `"${p}"`))}.\n`);
         return EXIT_USAGE;
     }
@@ -235,14 +253,47 @@ export async function main(argv) {
             'Use --stdout for the CSV, or --json for the summary.\n');
         return EXIT_USAGE;
     }
-    // One stream holds one table, for the same reason it holds one recording: concatenating
-    // them would give a CSV whose rows come from different files with nothing marking where
-    // one ends. Naming the count makes it obvious a glob was the cause.
+    /*
+      One stream holds one table, for the same reason it holds one recording: concatenating
+      them would give a CSV whose rows come from different files with nothing marking where
+      one ends. Naming the count makes it obvious a glob was the cause — except when the count
+      is one, which happens for a folder holding a single recording. That read "--stdout writes
+      a single CSV, so it cannot take 1 recordings": ungrammatical, and wrong on its face, since
+      one recording is exactly what it can take. What it cannot take is a folder, whose contents
+      are not known until they are walked.
+    */
     if (toStdout && batch) {
-        process.stderr.write(`--stdout writes a single CSV, so it cannot take ${inputs.length} recordings.\n` +
-            `Convert them to directories instead, or run edf2csv once per file.\n`);
+        process.stderr.write(inputs.length === 1
+            ? `--stdout writes a single CSV, and a folder is converted as a batch even when it ` +
+                `holds one recording.\nName the recording itself — ${inputs[0]} — or convert to a ` +
+                `directory instead.\n`
+            : `--stdout writes a single CSV, so it cannot take ${inputs.length} recordings.\n` +
+                `Convert them to directories instead, or run edf2csv once per file.\n`);
         return EXIT_USAGE;
     }
+    /*
+      Flags that --stdout has nowhere to put.
+  
+      Both were accepted and dropped in silence. `--out` names a directory that is never
+      created, so the run looked like it had written one. `--checksum` is worse than useless:
+      the hash is computed before the first record is read, which is a second full pass over
+      the input, and then the only file it is ever written to — metadata.json — is not written
+      at all. A recording large enough to want a checksum is large enough to notice reading it
+      twice for nothing.
+  
+      Refusing rather than ignoring is what this tool already does for `--stdout --json` and
+      `--stdout --annotations-only`.
+    */
+    for (const [flag, given] of [
+        ['--out', values['out'] !== undefined],
+        ['--checksum', values['checksum'] === true],
+    ]) {
+        if (toStdout && given) {
+            process.stderr.write(`--stdout and ${flag} cannot be combined: --stdout writes no files, and ${flag} has ` +
+                `nothing to act on.\nDrop ${flag}, or drop --stdout and convert to a directory.\n`);
+            return EXIT_USAGE;
+        }
+    }
     /*
       One recording prints the document it always printed; several print one per line.
   
@@ -581,7 +632,18 @@ async function convertOne(input, destination, options, emit = writeThrough) {
             // thing worth saying — on stderr, so the CSV on stdout stays clean.
             if (toStdout) {
                 const rows = result.files[0]?.rows ?? 0;
-                emit('err', `Wrote ${rows.toLocaleString('en-US')} rows to stdout.\n`);
+                /*
+                  A reader that closed the pipe did not receive a conversion, so it does not get a
+                  conversion's summary. `edf2csv rec.edf --stdout | head -1` announced "Wrote 52,507
+                  rows to stdout" — a number that is neither the recording's 102,400 nor the one row
+                  head took, but however many had been formatted before the close was noticed. The
+                  count that reached the reader is not knowable from this side; that it stopped early
+                  is, so that is what is said.
+                */
+                emit('err', result.readerHungUp
+                    ? `Stopped: the reader closed the pipe after ${rows.toLocaleString('en-US')} rows ` +
+                        `had been written. The recording was not converted in full.\n`
+                    : `Wrote ${rows.toLocaleString('en-US')} rows to stdout.\n`);
             }
             else {
                 emit('err', `${formatSummary(result)}\n`);