Skip to content

docs: Add benchmark analysis and visualization components#1578

Open
D-Sketon wants to merge 10 commits intotoss:mainfrom
D-Sketon:feat/bench
Open

docs: Add benchmark analysis and visualization components#1578
D-Sketon wants to merge 10 commits intotoss:mainfrom
D-Sketon:feat/bench

Conversation

@D-Sketon
Copy link
Contributor

@D-Sketon D-Sketon commented Jan 14, 2026

part of #1260

same as #1564. Introduce a generator script that runs benchmarks, writing the results to benchmark-results.json, and generates dynamic charts and tables from this JSON file.

script:

yarn run gen:benchmark

screenshot

{DD1CAB22-309F-460B-BB50-B05445AFB065}

The chart, table and environment card are dynamically generated.

Copilot AI review requested due to automatic review settings January 14, 2026 16:49
@vercel
Copy link

vercel bot commented Jan 14, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
es-toolkit Error Error Jan 30, 2026 6:11am

Request Review

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR introduces a benchmark analysis and visualization system that dynamically generates performance comparison charts, tables, and environment information for the documentation. The implementation replaces static benchmark data with components that read from a generated JSON file.

Changes:

  • Added a gen:benchmark script that runs benchmarks and outputs results to benchmark-results.json
  • Replaced static performance tables/images with dynamic Vue components (BenchmarkChart, BenchmarkTable, BenchmarkEnvironment)
  • Updated performance documentation across all locales to use the new components

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
package.json Added npm script to generate benchmark data
.scripts/generate-benchmark.mjs Benchmark generation script that runs tests and collects system info
docs/data/benchmark-results.json Sample benchmark results with performance metrics and environment data
docs/.vitepress/theme/index.js Registered new benchmark visualization components
docs/.vitepress/components/BenchmarkChart.vue Chart component for visualizing benchmark performance
docs/.vitepress/components/BenchmarkTable.vue Table component displaying benchmark comparisons
docs/.vitepress/components/BenchmarkEnvironment.vue Component showing test environment details
docs/performance.md Updated to use dynamic benchmark components
docs/ko/performance.md Korean locale updated to use dynamic components
docs/ja/performance.md Japanese locale updated to use dynamic components
docs/zh_hans/performance.md Chinese locale updated to use dynamic components

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@D-Sketon D-Sketon marked this pull request as ready for review January 15, 2026 16:18
@raon0211 raon0211 changed the title feat(docs): Add benchmark analysis and visualization components docs: Add benchmark analysis and visualization components Jan 30, 2026
@codecov-commenter
Copy link

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.97%. Comparing base (45f72ba) to head (c168a13).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1578   +/-   ##
=======================================
  Coverage   99.97%   99.97%           
=======================================
  Files         497      497           
  Lines        4660     4660           
  Branches     1347     1347           
=======================================
  Hits         4659     4659           
  Misses          1        1           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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.

3 participants