vitest-profiler - GitLite

KO | EN

gitlite — search

#python #ai #llm #rust #linux #docker #nodejs #macos #awesome #cli #awesome-list #mcp #openai #open-source

vitest-profiler

(★ 96)

A Vite plugin to profile Vitest test runs.

파일 탐색기

최종 버전 다운로드 (.zip)

- - ci.yml
.gitignore
cli.js
index.js
LICENSE.md
package.json
plugin.d.ts
plugin.js
pnpm-lock.yaml
README.md
release.config.json
utils.js

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/kettanaito/vitest-profiler

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd vitest-profiler

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm i vitest-profiler --save-dev

이 명령어를 터미널에 그대로 입력해 실행하세요.

vitest-profiler npm test

이 명령어를 터미널에 그대로 입력해 실행하세요.

"test:profile": "vitest-profiler npm test"

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# `vitest-profiler`

A Vite plugin to profile Vitest test runs.

## Motivation

Vitest has fantastic documentation on [Profiling Test Performance](https://vitest.dev/guide/profiling-test-performance.html). When it comes to profiling said performance in practice, it involves a series of configuration and Node.js process modifications that felt too tedious for me to repeat every time. Besides, you likely want those profiling options to be conditional anyway, to apply only when you actually want to profile your test run.

I've created this plugin to implement Vitest recommendations of test profiling while simultaneously giving you a nice experience while doing so. I also intend to keep this plugin in-sync with the Vitest team recommendations in the future so for you it's a single point of entry for accessible test profiling. Enjoy!

## Getting started

### 1. Install

First, add this package as a dependency to your project:

```sh
npm i vitest-profiler --save-dev
```

### 2. Add plugin

Next, add the `vitestProfiler` plugin from the `vitest-profiler/plugin` package to the `plugins` array of your Vite/Vitest configuration:

```js
// vite.config.js
import { vitestProfiler } from 'vitest-profiler/plugin'

export default defineConfig({
  plugins: [vitestProfiler()],
})
```

> The plugin automatically configures your threads/forks with the correct `execArgv` to provision Node.js process profiling.

### 3. Run tests

Finally, run your test command adding `vitest-profiler` before it:

```sh
vitest-profiler npm test
```

> The `vitest-profiler` CLI will automatically force your tests to be in the `run` mode (not `watch`).

Alternatively, you can create a custom NPM script to use as a shorthand:

```json
{
  "scripts": {
    "test": "vitest",
    "test:profile": "vitest-profiler npm test"
  }
}
```

### 4. Observe output

After running your tests with the profiler, you will see a message listing all the generated profiles:

```sh
Test profiling complete! Generated the following profiles:

main-thread:
    - CPU:      test-profiles/2025-04-08-10-30-12-main-thread.cpuprofile

tests:
    - CPU:      test-profiles/2025-04-08--10-30-12-tests.cpuprofile
    - Heap:     test-profiles/2025-04-08--10-30-12-tests.heapprofile
```

Navigate to the respective files to observe and debug your test performance. Here's a quick guide on each file:

- **CPU profiles** (`*.cpuprofile`) record your CPU usage during the test run. Look here to see what takes the most _time_ in your tests;
- **Heap profiles** (`*.heapprofile`) record memory usage during the test run. Look here for potential _memory leaks/heaps_ and other memory management issues.