Skip to content

docs: refresh README with relevance notes#32

Merged
mxschmitt merged 1 commit into
mainfrom
chore/refresh-readme
May 24, 2026
Merged

docs: refresh README with relevance notes#32
mxschmitt merged 1 commit into
mainfrom
chore/refresh-readme

Conversation

@mxschmitt

Copy link
Copy Markdown
Owner

Summary

  • Adds a "verified with" line listing the current stack (React 19, Vite 8, TS 6, Playwright 1.60, vite-plugin-istanbul 9, nyc 18) so readers landing here know the example is fresh.
  • Adds a "Why not Playwright's built-in coverage?" section explaining the V8/Chromium-only limitations and why Istanbul instrumentation is still the right approach for app-level e2e coverage.
  • Notes that vite-plugin-istanbul v9 requires Vite ≥7 and is ESM-only, which is why the config now lives at vite.config.mts.
  • Clarifies that the create-react-app branch is an archived reference since CRA is no longer maintained.

Test plan

  • README renders correctly (markdown only, no code changes)

Adds a "verified with" line so readers can see the stack was refreshed,
explains why this repo's Istanbul-based approach is preferred over
Playwright's built-in V8 coverage (Chromium-only, hard to merge,
needs source-map post-processing), notes that vite-plugin-istanbul v9
requires Vite >=7 and is ESM-only (hence vite.config.mts), and clarifies
that the create-react-app branch is an archived reference since CRA is
no longer maintained.
@mxschmitt mxschmitt merged commit 910da57 into main May 24, 2026
1 check passed
@mxschmitt mxschmitt deleted the chore/refresh-readme branch May 24, 2026 18:24
@coveralls

Copy link
Copy Markdown

Coverage Report for CI Build 26369205470

Warning

Build has drifted: This PR's base is out of sync with its target branch, so coverage data may include unrelated changes.
Quick fix: rebase this PR. Learn more →

Coverage remained the same at 90.909%

Details

  • Coverage remained the same as the base build.
  • Patch coverage: No coverable lines changed in this PR.
  • No coverage regressions found.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

No coverage regressions found.


Coverage Stats

Coverage Status
Relevant Lines: 11
Covered Lines: 10
Line Coverage: 90.91%
Coverage Strength: 2.73 hits per line

💛 - Coveralls

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants