edfcore 0.4.237 → 0.4.239
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 +5 -4
- package/dist/constants.d.ts +1 -1
- package/dist/constants.js +1 -1
- package/docs/CHANGELOG.md +24 -0
- package/package.json +1 -1
- package/src/constants.ts +1 -1
package/README.md
CHANGED
|
@@ -397,7 +397,7 @@ exactly the invention this library refuses. JSR publication.
|
|
|
397
397
|
|
|
398
398
|
The full documentation site lives in
|
|
399
399
|
[`website/`](https://github.com/tayal-sarthak/edfcore/tree/main/website), an Astro build with
|
|
400
|
-
|
|
400
|
+
22 pages.
|
|
401
401
|
It includes a **local inspector** that opens an EDF file and shows its header, channels, events
|
|
402
402
|
and waveforms in your browser, with nothing uploaded.
|
|
403
403
|
|
|
@@ -406,9 +406,10 @@ npm install --prefix website
|
|
|
406
406
|
npm run dev --prefix website
|
|
407
407
|
```
|
|
408
408
|
|
|
409
|
-
Start with **Concepts**, which is the mental model the rest of the API follows from. Then the
|
|
410
|
-
|
|
411
|
-
pages. Those include a standalone primer on the EDF format itself.
|
|
409
|
+
Start with **Concepts**, which is the mental model the rest of the API follows from. Then the
|
|
410
|
+
guides — one per task, from reading signals to validation — the API reference, and the background
|
|
411
|
+
pages. Those include a standalone primer on the EDF format itself. There is no inventory of them
|
|
412
|
+
here on purpose — the sidebar is generated from the pages themselves, so it is the list.
|
|
412
413
|
|
|
413
414
|
### Deploying the site
|
|
414
415
|
|
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.239";
|
|
113
113
|
//# sourceMappingURL=constants.d.ts.map
|
package/dist/constants.js
CHANGED
package/docs/CHANGELOG.md
CHANGED
|
@@ -6,6 +6,30 @@ 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.239
|
|
10
|
+
|
|
11
|
+
- **Added** the guard for what 0.4.237 fixed: no test may glob a TypeScript or `.astro` file out
|
|
12
|
+
of `website/`. `?raw` returns bytes, but the path still goes through vite's transform, and the
|
|
13
|
+
transform resolves that file's nearest tsconfig — which for anything under `website/` extends
|
|
14
|
+
`astro/tsconfigs/strict` out of `website/node_modules`, a directory the CI `check` job never
|
|
15
|
+
installs. That is a failure mode with no local symptom at all: the command passes on the machine
|
|
16
|
+
cutting the release and dies on every runner, which is exactly how six versions came to be
|
|
17
|
+
tagged and never published. Markdown stays allowed, because no JavaScript tooling reads a `.md`
|
|
18
|
+
file's tsconfig. The scanner uses `readFileSync` rather than a glob, on the same reasoning one
|
|
19
|
+
level up.
|
|
20
|
+
|
|
21
|
+
## 0.4.238
|
|
22
|
+
|
|
23
|
+
- **Fixed** the README undercounting the documentation site. It said "an Astro build with twenty
|
|
24
|
+
pages" and the collection holds twenty-two — the same shape of defect as the API surface table
|
|
25
|
+
two sections above it, which has been checked since 0.1.x. The number is now written as digits
|
|
26
|
+
and read against the collection, because a number a test has to read should be written the way
|
|
27
|
+
a test can read it.
|
|
28
|
+
- **Removed** the hand-written list of guides in the sentence after it, which named eight of the
|
|
29
|
+
nine. The sidebar is generated from the pages, so it is the list; a paragraph that restates it
|
|
30
|
+
is one more inventory to keep in step, and the site has now lost three of those in nine
|
|
31
|
+
releases.
|
|
32
|
+
|
|
9
33
|
## 0.4.237
|
|
10
34
|
|
|
11
35
|
- **Fixed** `npm run check` failing on any machine without the website's dependencies installed,
|
package/package.json
CHANGED
package/src/constants.ts
CHANGED