edfcore 0.2.65 → 0.2.66
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/CHANGELOG.md +31 -6
- package/README.md +1 -1
- package/dist/constants.d.ts +1 -1
- package/dist/constants.js +1 -1
- package/package.json +1 -1
- package/src/constants.ts +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -6,7 +6,26 @@ 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.2.
|
|
9
|
+
## 0.2.66
|
|
10
|
+
|
|
11
|
+
- **Fixed** the changelog numbering, which had drifted a second time, and **fixed the cause** so it
|
|
12
|
+
cannot drift a third.
|
|
13
|
+
- The mechanism, both times: the entry is written by hand before the release runs, against the
|
|
14
|
+
version the author expects. When a release fails AFTER bumping — a lint error, a flaky test, an
|
|
15
|
+
agent's scratch file in the tree — that number is consumed, the next run produces a different
|
|
16
|
+
one, and every heading from there on inherits the drift. `0.2.29` and `0.2.36` went that way in
|
|
17
|
+
the last round; `0.2.59` went that way in this one, consumed by its own coverage guard when a
|
|
18
|
+
corpus file was added without regenerating its parity golden.
|
|
19
|
+
- `scripts/release.mjs` now refuses to release unless the top `## <version>` heading in
|
|
20
|
+
CHANGELOG.md equals the version being tagged, and its message says what to do — including
|
|
21
|
+
recording a skipped number as never released. One file read, and a silent documentation defect
|
|
22
|
+
becomes a message before anything is committed.
|
|
23
|
+
- Headings `0.2.59` through `0.2.64` are shifted to the releases that actually carried them,
|
|
24
|
+
verified against `git show <tag>:CHANGELOG.md` rather than reasoned about, and `0.2.59` is
|
|
25
|
+
recorded as never released. Prose references in the README, the docs and one test are shifted to
|
|
26
|
+
match.
|
|
27
|
+
|
|
28
|
+
## 0.2.65
|
|
10
29
|
|
|
11
30
|
- **Added** a migration guide for 0.3.0, published before the release rather than after it:
|
|
12
31
|
[Migrating to 0.3](https://edfcore.vercel.app/docs/migrating-to-0-3). Three functions are
|
|
@@ -20,7 +39,7 @@ defect; those are called out below.
|
|
|
20
39
|
- Includes the find-and-replace, with word boundaries, and a note on why: `sampleStartTicks` and
|
|
21
40
|
`sampleStartTicksOf` are distinct names and a substring replace would damage the second.
|
|
22
41
|
|
|
23
|
-
## 0.2.
|
|
42
|
+
## 0.2.64
|
|
24
43
|
|
|
25
44
|
- **Added** a test that drives essentially the whole public barrel over every corpus file — six
|
|
26
45
|
files written by five pieces of software across twenty-one years — and asserts the results are
|
|
@@ -34,7 +53,7 @@ defect; those are called out below.
|
|
|
34
53
|
nowhere written down, and the sleep-edfx hypnogram is a real file of exactly that shape. Now
|
|
35
54
|
stated in the source, in the docs, and pinned by the test that found it.
|
|
36
55
|
|
|
37
|
-
## 0.2.
|
|
56
|
+
## 0.2.63
|
|
38
57
|
|
|
39
58
|
- **Added** `formatAnnotations`, the third formatter beside `formatHeader` and
|
|
40
59
|
`formatDiagnostics`, and the one a hypnogram or an event list actually needs.
|
|
@@ -49,7 +68,7 @@ defect; those are called out below.
|
|
|
49
68
|
the header start time, a recording may begin after its first annotation, and clamping to zero
|
|
50
69
|
would silently move it.
|
|
51
70
|
|
|
52
|
-
## 0.2.
|
|
71
|
+
## 0.2.62
|
|
53
72
|
|
|
54
73
|
- **Deprecated** `sampleIndexAt`, `sampleStartTicks` and `sampleStartSeconds`, which are renamed
|
|
55
74
|
to `gridSampleIndexAt`, `gridSampleStartTicks` and `gridSampleStartSeconds` in **0.3.0**. The
|
|
@@ -62,7 +81,7 @@ defect; those are called out below.
|
|
|
62
81
|
- Nothing is removed here. An editor will point at the replacement a release before the rename
|
|
63
82
|
lands, and for a contiguous file the rename is the only thing that affects a caller.
|
|
64
83
|
|
|
65
|
-
## 0.2.
|
|
84
|
+
## 0.2.61
|
|
66
85
|
|
|
67
86
|
- **Added** `sampleAt`, `sampleStartTicksOf` and `sampleStartSecondsOf` — the recording-aware
|
|
68
87
|
counterpart to the sample-grid family, and the groundwork for 0.3.0.
|
|
@@ -79,7 +98,7 @@ defect; those are called out below.
|
|
|
79
98
|
follows. A round-trip test pins the pair together across the gap: the sample at a sample's start
|
|
80
99
|
is that sample, for every sample in the file.
|
|
81
100
|
|
|
82
|
-
## 0.2.
|
|
101
|
+
## 0.2.60
|
|
83
102
|
|
|
84
103
|
- **Added** `calib.rec` from edfplus.info — the last corpus the README named. It was written by
|
|
85
104
|
**Bob Kemp, who wrote the EDF specification**, expressly to check that a reader gets amplitude
|
|
@@ -99,6 +118,12 @@ defect; those are called out below.
|
|
|
99
118
|
the new corpus file had no parity golden yet. That is exactly the drift it exists to catch, and
|
|
100
119
|
it caught it before the release rather than after.
|
|
101
120
|
|
|
121
|
+
## 0.2.59
|
|
122
|
+
|
|
123
|
+
Never released. The 0.2.59 release run failed its own coverage guard — a corpus file had been added
|
|
124
|
+
without regenerating its parity golden — which consumed the number before a tag was cut. The
|
|
125
|
+
calibration-file work that carried this heading while it was being written shipped in `0.2.60`.
|
|
126
|
+
|
|
102
127
|
## 0.2.58
|
|
103
128
|
|
|
104
129
|
- **Added** CHB-MIT to the corpus, closing a gap the README has named since 0.1. It is chosen to be
|
package/README.md
CHANGED
|
@@ -341,7 +341,7 @@ also supplies something no synthetic fixture here had — a montage that names o
|
|
|
341
341
|
which is what `EdfAmbiguousChannelError` exists for and had until now only ever been raised against
|
|
342
342
|
a fixture written to raise it.
|
|
343
343
|
|
|
344
|
-
**The format author's own calibration file, as of 0.2.
|
|
344
|
+
**The format author's own calibration file, as of 0.2.60.** `calib.rec` was written by Bob Kemp —
|
|
345
345
|
who wrote the EDF specification — expressly to check that a reader gets amplitude *and polarity*
|
|
346
346
|
right. It is the only fixture here whose expected values come from neither edfcore nor another
|
|
347
347
|
library but from the file's own design: its gain is 25/1024, exactly representable in binary, so
|
package/dist/constants.d.ts
CHANGED
|
@@ -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.2.
|
|
112
|
+
export declare const VERSION = "0.2.66";
|
|
113
113
|
//# sourceMappingURL=constants.d.ts.map
|
package/dist/constants.js
CHANGED
package/package.json
CHANGED
package/src/constants.ts
CHANGED