Skip to content

Commit 3669ebb

Browse files
fix: correct spelling in README and update cspell configuration
1 parent a0fbc52 commit 3669ebb

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

cspell.config.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@
6060
"somthingelse",
6161
"stylelint",
6262
"TOGGLEFULLSCREEN",
63+
"unasserted",
6364
"UPDATEMM",
6465
"userpresence",
6566
"vcgencmd",

tests/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,13 @@ Together these suites focus on code that mutates state, touches the filesystem,
2525

2626
## What we deliberately skip (and why)
2727

28-
- **Router-to-handler wiring:** Express route-mapping tests were dropped because they duplicated framework behaviour and were brittle whenever routes were reordered. Manual smoke tests or integration tests are a better fit.
28+
- **Router-to-handler wiring:** Express route-mapping tests were dropped because they duplicated framework behavior and were brittle whenever routes were reordered. Manual smoke tests or integration tests are a better fit.
2929
- **System commands and hardware control (`shutdown`, `reboot`, monitor control):** they depend on Raspberry Pi hardware privileges and side effects we can’t safely stub in CI.
3030
- **Front-end DOM or E2E coverage:** Rendering happens in the MagicMirror browser context; replicating it would require Puppeteer/Electron harnesses that are heavy relative to the payoff.
3131
- **“Pass-through” notification wrappers:** Flows that simply forward parameters (`HIDE_ALERT`, `SHOW_ALERT`, etc.) are exercised indirectly by higher-level tests; duplicating them would be noise.
3232
- **Git/network dependent paths:** Update and install code paths require repositories and network access. We guard their public contract via `getExternalApiByGuessing`/menu tests instead.
3333

34-
Documenting these gaps helps us recognise when a change might require a different kind of test (manual check, integration smoke, etc.).
34+
Documenting these gaps helps us recognize when a change might require a different kind of test (manual check, integration smoke, etc.).
3535

3636
## Fixtures and shims
3737

@@ -42,16 +42,16 @@ Documenting these gaps helps us recognise when a change might require a differen
4242
## Potential future enhancements
4343

4444
- Add a focused regression test for `answerPost` when the config read stream errors mid-pipe (currently logged but unasserted).
45-
- Capture a tiny contract test for `/api/saves` to freeze the backup timestamp ordering behaviour.
46-
- Explore lightweight schema validation for `/api/module/available` once module metadata stabilises—could reuse the existing helper stubs.
45+
- Capture a tiny contract test for `/api/saves` to freeze the backup timestamp ordering behavior.
46+
- Explore lightweight schema validation for `/api/module/available` once module metadata stabilizes—could reuse the existing helper stubs.
4747
- Consider bumping coverage thresholds modestly (for example to 10%) once the above additions land and prove stable.
4848

49-
These ideas stay deliberately small; larger endeavours (integration or E2E) are still considered out of scope unless requirements change.
49+
These ideas stay deliberately small; larger endeavors (integration or E2E) are still considered out of scope unless requirements change.
5050

5151
## Contribution guidelines
5252

5353
- Prefer deterministic unit tests with explicit stubbing over fragile integration harnesses.
54-
- Question every prospective test: if it simply mirrors production code without behaviour, it’s likely not worth adding.
54+
- Question every prospective test: if it simply mirrors production code without behavior, it’s likely not worth adding.
5555
- Keep pull requests focused—group related assertions in the same suite and avoid cross-cutting rewrites.
5656
- Restore any global/mocked state (`Module._load`, timers, `fs`) in `afterEach` blocks to keep suites isolated.
5757

0 commit comments

Comments
 (0)