Feat: Add Markdown table report for benchmark results#654
Conversation
🦋 Changeset detectedLatest commit: 8cbabd7 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
@resham57 Thanks for your contribution ! can you add the changeset |
BREAKING CHANGE: benchmark results are now written only as a Markdown table (report.md); report.json and its generation code have been removed.
It's my pleasure, @clemgbld. I've applied the changes you have mentioned and added a new changeset. Could you please review them once more and let me know if any further changes changes are required? I'll be happy to make them. Thank you! |
Summary
formatDuration,formatBytes,toMarkdown) to create human-readable reportreport.mdto an existingbenchmark/write-snapshot.tsmoduleformatDuration,formatBytes,toMarkdown) into a newbenchmark/markdown.tsmodulewrite-snapshot.tsto import frommarkdown.tsand write a human-readablereport.mdalongside the existingreport.jsonreport.json+ newreport.md)—fallback when heap/gc data is absent, and multi-row renderingLinked Issue
Closes: #612
Verification
node --test workspaces/js-x-ray/test/markdown.spec.tspasses(14 tests across
formatDuration,formatBytes,toMarkdown)npx eslint workspacesreports no errorsnpm run buildReport
Test