Skip to content

Commit 7c7978a

Browse files
docs(test + build): Include build and testing comands throught all the paths.
1 parent a1c1e50 commit 7c7978a

4 files changed

Lines changed: 38 additions & 7 deletions

File tree

cli/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,17 @@ cargo install --path cli
2828

2929
Full command reference, flags, and examples: [edgepython.com/reference/cli](https://edgepython.com/reference/cli).
3030

31+
## Build + test
32+
33+
The CLI is a standalone Cargo workspace under `cli/`. Commands run from there:
34+
35+
```bash
36+
cd cli
37+
cargo clippy --all-targets -- -D warnings # lint
38+
cargo check # type-check
39+
cargo test # run tests (requires google-chrome-stable on PATH)
40+
```
41+
3142
## License
3243

3344
MIT OR Apache-2.0

host/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,23 @@ One folder per capability. Each ships a `<name>/<name>.json` corpus; the shared
5050
| `storage` | localStorage, sessionStorage, IndexedDB, see [`storage/README.md`](storage/README.md) |
5151
| `time` | Clocks, sleep, calendar formatting, see [`time/README.md`](time/README.md) |
5252

53+
## Development
54+
55+
Requires [Deno v2](https://deno.com/) and Playwright's Chromium.
56+
57+
```bash
58+
# Lint one capability
59+
cd host/<capability> && deno lint src/
60+
61+
# Install Chromium (once)
62+
deno run -A npm:playwright install --with-deps chromium
63+
64+
# Test one capability (from host/)
65+
cd host && HOSTCAP=<capability> deno test --allow-all tests/
66+
```
67+
68+
`<capability>` is one of `dom`, `network`, `storage`, `time`.
69+
5370
## License
5471

5572
MIT OR Apache-2.0

runtime/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22

33
JS half of Edge Python: hosts `compiler.wasm` in a Web Worker, resolves and registers `.py` / `.wasm` modules, dispatches native calls. Drive it programmatically with `createWorker`, or declaratively with the `<edge-python>` HTML element.
44

5+
## Development
6+
7+
Requires [Deno v2](https://deno.com/) and Playwright's Chromium (installed on first run).
8+
9+
```bash
10+
deno lint runtime/ # lint
11+
deno run -A npm:playwright install --with-deps chromium # install Chromium (once)
12+
deno test --allow-all runtime/tests/runtime.test.js # run tests
13+
```
14+
515
## Install
616

717
No install, the official CDN serves both the runtime and matching `compiler.wasm`:

std/README.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,6 @@
22

33
Official standard-library packages for [Edge Python](https://edgepython.com). Most are a Rust crate compiled to `wasm32-unknown-unknown` against the [wasm-pdk](https://github.com/dylan-sutton-chavez/edge-python/tree/main/wasm-pdk) ABI; hosts load the resulting `.wasm` over the standard plugin contract, no custom embedder, no Rust on the consumer side. A package can also ship as pure Edge Python source (`src/entry.py`), imported as a code module with no `cargo` build (e.g. `test`).
44

5-
## Layout
6-
7-
```
8-
tests/, agnostic Deno + Playwright runner driving the <edge-python> tag
9-
<name>/, one folder per stdpkg, with src/, README.md, and <name>.json corpus
10-
```
11-
125
The folder name IS the package name. A native package builds to `<name>/target/wasm32-unknown-unknown/release/<name>.wasm`; a pure-Python package has `src/entry.py` and no build artifact. Each package's `<name>.json` corpus sits in its folder; cases in it are automatically prefixed with `from <name> import *\n` before dispatch, so the corpus only contains the code being tested.
136

147
## Packages

0 commit comments

Comments
 (0)