mirror of
https://github.com/priyanshujain/sanderling.git
synced 2026-10-02 19:17:10 +00:00
WIP: docs: refresh after iOS + web support (#50)
* docs: README covers iOS + web, surface both example apps * docs(cli): document --ios-device and per-platform doctor * docs: tighten README, fold examples into Docs list * docs(runs): correct --clear-data lifecycle wording Default behavior no longer wipes app data between runs; --clear-data is now opt-in. * docs(getting-started): add iOS path, separate folio and folio-web Document just test-ios under examples/folio, and distinguish the KMP sample from the React + Vite folio-web sample. * docs(inspect): document the eight panels Lists Screenshot, ActionList, Timeline, ViolationsPanel, HierarchyPanel, SnapshotTable, MetricsChart, ExceptionsPanel. Cross-links HierarchyPanel to the spec language reference. * docs(writing-specs): document setup export, flag noLogcatErrors as android-only Mirrors pkg/spec/README.md so the manual covers the runner's setup-first fall-through. Marks noLogcatErrors as Android-only so iOS/web spec authors know it silently no-ops. * docs(folio): document web target and iOS sanderling test recipe After the KMP refactor folio also runs on wasmJs and the justfile exposes just web, just web-build, and just test-ios. Surface all three. * docs(folio-web): add README Covers prerequisites, demo credentials, just test recipe, and how the React + Vite host exposes state to the sanderling spec via stable ids and data-* attributes. * docs: scrub driver-implementation name from user docs Drop the implementation tool name from README, cli.md doctor table, and spec-language.md. These docs should describe behaviour, not the specific underlying tool the native sidecar wraps. * docs(development): scrub driver-implementation name from dev docs architecture, design-principles, decisions now describe the native sidecar by role (gRPC surface over OS UI-test pipeline) rather than by the specific tool it wraps.
This commit is contained in:
12 files changed
+178
-28
No files matched your search
@@ -2,8 +2,8 @@
|
||||
|
||||
A minimal Kotlin Multiplatform personal-ledger app: login with demo
|
||||
credentials, create accounts, add credits and debits. Shared UI across
|
||||
Android and iOS via Compose Multiplatform. Doubles as the example
|
||||
sanderling runs its property-based specs against.
|
||||
Android, iOS, and web (wasmJs via Compose for Web). Doubles as the
|
||||
example sanderling runs its property-based specs against.
|
||||
|
||||
## Stack
|
||||
|
||||
@@ -39,6 +39,16 @@ IOS_DEVICE="iPhone 15" just ios # pick a different simulator
|
||||
builds the KMP framework (`Shared.framework` from `:app:shared`), links it
|
||||
into the SwiftUI host, installs, and launches.
|
||||
|
||||
## Web
|
||||
|
||||
```sh
|
||||
just web # webpack dev server with COOP/COEP headers
|
||||
just web-build # produce a webpack distributable bundle
|
||||
```
|
||||
|
||||
`just web` runs `:app:webApp:wasmJsBrowserDevelopmentRun --continuous`, so
|
||||
edits to shared code reload in the browser.
|
||||
|
||||
## Demo credentials
|
||||
|
||||
```
|
||||
@@ -68,6 +78,17 @@ DURATION=5m
|
||||
|
||||
Traces land in `./sanderling/runs/<timestamp>/`.
|
||||
|
||||
## Run a sanderling test (iOS)
|
||||
|
||||
```sh
|
||||
just test-ios # default simulator: iPhone 17 Pro
|
||||
IOS_DEVICE="iPhone 15" just test-ios # pick a different simulator
|
||||
```
|
||||
|
||||
`just test-ios` boots the simulator if needed, runs `just ios` to install
|
||||
and launch the app, then invokes `sanderling test --platform ios`. Same
|
||||
`DURATION`, `SEED`, and `OUTPUT` env vars as the Android target.
|
||||
|
||||
## How it connects to sanderling
|
||||
|
||||
- Each screen sets a stable Compose `testTag` (`HomeScreen`, `AccountCard`,
|
||||
|
||||
Reference in new issue
Block a user