edfcore 0.6.10 → 0.6.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/cli-run.js CHANGED
@@ -57,7 +57,7 @@ const USAGE = `edfcore — read EDF, EDF+, BDF and BDF+ files
57
57
 
58
58
  Options
59
59
  --help, -h print this and exit 0
60
- --patient include patient identification (header, validate, json)
60
+ --patient include both identification fields (header, validate, json)
61
61
  --list list events one per line instead of counting (events)
62
62
  --limit <n> diagnostics or events to print, default ${DEFAULT_ITEM_LIMIT}
63
63
  (header, validate, events --list)
@@ -109,5 +109,5 @@ export declare const SIGNAL_FIELD_BLOCK_OFFSETS: {
109
109
  readonly reserved: 224;
110
110
  };
111
111
  /** Published package version. Kept in sync with package.json by a test. */
112
- export declare const VERSION = "0.6.10";
112
+ export declare const VERSION = "0.6.11";
113
113
  //# sourceMappingURL=constants.d.ts.map
package/dist/constants.js CHANGED
@@ -79,5 +79,5 @@ export const SIGNAL_FIELD_BLOCK_OFFSETS = {
79
79
  reserved: 224,
80
80
  };
81
81
  /** Published package version. Kept in sync with package.json by a test. */
82
- export const VERSION = '0.6.10';
82
+ export const VERSION = '0.6.11';
83
83
  //# sourceMappingURL=constants.js.map
package/docs/CHANGELOG.md CHANGED
@@ -6,6 +6,25 @@ alone does not tell you whether you were affected.
6
6
  edfcore is pre-1.0. Patch releases have carried behaviour changes where the old behaviour was a
7
7
  defect; those are called out below.
8
8
 
9
+ ## 0.6.11
10
+
11
+ - **Fixed** `--help` still describing `--patient` as "include patient identification" after 0.6.7
12
+ made it gate both identification fields. The page was updated then and the help text was not —
13
+ and the help text is the documentation that ships inside the package and is read by people who
14
+ never open a website.
15
+ - The drift was possible because the commands are checked three ways and the flags were checked
16
+ one and a half. `api-surface.test.ts` counts the `--help` command list against the README's
17
+ table, `cli-command-list.test.ts` asserts `--help` offers exactly what the dispatch switch
18
+ handles, and `documented-cli.test.ts` runs every `npx edfcore …` written across the docs.
19
+ `cli-flag-matrix.test.ts` reads the page's flag paragraph and checks the behaviour against it.
20
+ Nothing compared the page with the help text.
21
+ - `help-and-the-page-agree.test.ts` compares the two on the two things a reader acts on: which
22
+ flags exist, and which commands each one names. Wording is deliberately not compared — the page
23
+ has paragraphs and `--help` has a column, and making them match word for word would make one of
24
+ them worse — so the specific drift is kept as its own case beside the set check, which would have
25
+ passed on the old wording because what changed was what the flag does rather than where it
26
+ applies.
27
+
9
28
  ## 0.6.10
10
29
 
11
30
  - **Fixed** the signal table in `edfcore header` ending a row in whitespace whenever a signal's
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "edfcore",
3
- "version": "0.6.10",
3
+ "version": "0.6.11",
4
4
  "description": "Modern, typed, zero-dependency reader for EDF, EDF+, BDF and BDF+ biosignal files. Works in browsers and Node with true random access.",
5
5
  "keywords": [
6
6
  "edf",
package/src/cli-run.ts CHANGED
@@ -69,7 +69,7 @@ const USAGE = `edfcore — read EDF, EDF+, BDF and BDF+ files
69
69
 
70
70
  Options
71
71
  --help, -h print this and exit 0
72
- --patient include patient identification (header, validate, json)
72
+ --patient include both identification fields (header, validate, json)
73
73
  --list list events one per line instead of counting (events)
74
74
  --limit <n> diagnostics or events to print, default ${DEFAULT_ITEM_LIMIT}
75
75
  (header, validate, events --list)
package/src/constants.ts CHANGED
@@ -93,4 +93,4 @@ export const SIGNAL_FIELD_BLOCK_OFFSETS = {
93
93
  } as const;
94
94
 
95
95
  /** Published package version. Kept in sync with package.json by a test. */
96
- export const VERSION = '0.6.10';
96
+ export const VERSION = '0.6.11';