edfcore 0.4.477 → 0.4.479
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/README.md +4 -5
- package/dist/constants.d.ts +1 -1
- package/dist/constants.js +1 -1
- package/docs/CHANGELOG.md +35 -0
- package/package.json +1 -1
- package/src/constants.ts +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
# edfcore
|
|
2
2
|
|
|
3
|
-
[](https://edfcore.vercel.app/api.json)
|
|
4
3
|
[](https://www.npmjs.com/package/edfcore)
|
|
5
4
|
|
|
6
5
|
edfcore reads EDF, EDF+, BDF and BDF+ biosignal files in TypeScript, in the browser and in
|
|
@@ -310,10 +309,10 @@ the reason to trust the reader.
|
|
|
310
309
|
|
|
311
310
|
Every number above is asserted against the package by
|
|
312
311
|
[`tests/integration/api-surface.test.ts`](tests/integration/api-surface.test.ts) — it counts the
|
|
313
|
-
real exports, renders the real `--help`, and fails when this table drifts from either. The
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
312
|
+
real exports, renders the real `--help`, and fails when this table drifts from either. The same
|
|
313
|
+
counts are served at [`/api.json`](https://edfcore.vercel.app/api.json), which the documentation
|
|
314
|
+
site generates at deploy time by importing the three published entry points and counting them, so
|
|
315
|
+
it needs no maintenance at all.
|
|
317
316
|
|
|
318
317
|
---
|
|
319
318
|
|
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.4.
|
|
112
|
+
export declare const VERSION = "0.4.479";
|
|
113
113
|
//# sourceMappingURL=constants.d.ts.map
|
package/dist/constants.js
CHANGED
package/docs/CHANGELOG.md
CHANGED
|
@@ -6,6 +6,41 @@ 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.4.479
|
|
10
|
+
|
|
11
|
+
- **Fixed** a check that could pass on the machine that broke it and fail on CI. `file-references`
|
|
12
|
+
resolves a backticked path against every file in the working tree, and its skip list held
|
|
13
|
+
`scratch` but not `deleted` — both gitignored, both present only on the machine that put them
|
|
14
|
+
there.
|
|
15
|
+
- Found by hitting it. Retiring the badge-contract file to `deleted/` in 0.4.478 left a changelog
|
|
16
|
+
entry naming it; the reference resolved here and dangled on a clean checkout, so all three Node
|
|
17
|
+
jobs failed on the commit that retired the file — the moment its author is least expecting a
|
|
18
|
+
reference to it to break.
|
|
19
|
+
- The asymmetry is what made it easy to miss. The second walk in that file descends only `src`,
|
|
20
|
+
`tests`, `scripts` and `config`, so a retired file can never MAKE a claim; it could only ever
|
|
21
|
+
vouch for one.
|
|
22
|
+
- The walk is now a named function taking a root, and the new case runs it on a temporary tree
|
|
23
|
+
holding one live file, one under `deleted/` and one under `scratch/`. On the real tree the
|
|
24
|
+
assertion would say nothing on CI, where neither directory exists — which is the same trap one
|
|
25
|
+
level up.
|
|
26
|
+
|
|
27
|
+
## 0.4.478
|
|
28
|
+
|
|
29
|
+
- **Removed** the `exports` badge from the top of the README, at the user's request. The number it
|
|
30
|
+
showed is still in the API surface table further down, and still counted rather than typed.
|
|
31
|
+
- `/api.json` stays. The README links it, the site serves it, and the reason it exists — a
|
|
32
|
+
published count that a human wrote is the site footer that read "Version 0.1.0" through three
|
|
33
|
+
minor series — is unchanged by the badge going. Its docblock said it existed to back the badge,
|
|
34
|
+
which is no longer true, so it now says what it is.
|
|
35
|
+
- The badge-contract test was entirely about that badge: it pulled the JSONPath out of the
|
|
36
|
+
shields.io URL and walked it through the object the endpoint builds, because shields.io renders
|
|
37
|
+
a broken path as "invalid" in a corner nobody reads. With no badge there is no URL to read, so
|
|
38
|
+
the file has been retired to the repository's `deleted/` folder — and the half of it that still
|
|
39
|
+
has a subject, that `exports.total` resolves and equals the README's table, moved into
|
|
40
|
+
`api-badge.test.ts` rather than leaving with it.
|
|
41
|
+
- That file now also asserts the badge is absent, so it cannot drift back in beside a table that
|
|
42
|
+
states the same number one line below it.
|
|
43
|
+
|
|
9
44
|
## 0.4.477
|
|
10
45
|
|
|
11
46
|
- **Added** the case where a 206 says which bytes it sent and not how large the resource is. The
|
package/package.json
CHANGED
package/src/constants.ts
CHANGED