@react-perfscope/core 0.1.0 → 0.1.1

package/README.md

@@ -1,31 +1,14 @@
 # @react-perfscope/core
 
-Core recording engine for `react-perfscope`. Provides a `Recorder` and pluggable `Collector`s that emit normalized performance signals.
+Core recording engine for `react-perfscope`. Provides a `Recorder` and pluggable `Collector`s that emit normalized performance signals (forced-reflow, long-tasks, layout-shift, network, web-vitals, paint).
 
-## Status
+## Install
 
-Phase 2 complete — `@react-perfscope/core` ships all 6 core collectors (forced-reflow, long-tasks, layout-shift, network, web-vitals, paint) with deferred stack parsing and synchronous dirty tracking on forced-reflow.
-
-**Forced-reflow note:** Synchronous dirty tracking via `MutationObserver.takeRecords()` ensures the collector only emits when DOM mutated since the last layout read. Stack parsing is deferred until `signal.stack` is accessed.
-
-**Paint collector note:** Phase 2 emits paint entries with a zero-sized `rect` placeholder. Real mutated-region geometry arrives with the UI package in Phase 3.
-
-The `render` signal is owned by the upcoming `@react-perfscope/react` package (Phase 3) and not yet emitted.
-
-## Source-map resolution
-
-`createSourceMapResolver()` returns an async resolver that follows `//# sourceMappingURL=` references (including inline `data:` URIs), caches the parsed source map per source URL, and resolves a `StackFrame` to its original source position. The UI uses this to make bundled stack traces readable.
-
-```ts
-import { createSourceMapResolver } from '@react-perfscope/core'
-
-const resolver = createSourceMapResolver()
-const original = await resolver.resolve(parsedFrame)
+```sh
+npm install @react-perfscope/core
 ```
 
-Falls back to the input frame on any failure (missing source map, network error, etc.).
-
-## Example
+## Usage
 
 ```ts
 import {
@@ -53,38 +36,32 @@ const result = recorder.stop()
 console.log(result.signals)
 ```
 
----
-
-<a id="한국어"></a>
-
-# 한국어
-
-`react-perfscope`의 핵심 레코딩 엔진. `Recorder`와 플러그인 방식의 `Collector`를 제공해서 정규화된 성능 신호를 내보낸다.
+## Source-map resolution
 
-## 상태
+`createSourceMapResolver()` returns an async resolver that follows `//# sourceMappingURL=` references (including inline `data:` URIs) and resolves a `StackFrame` to its original source position, so bundled stack traces become readable. Falls back to the input frame on any failure.
 
-Phase 2 완료 — `@react-perfscope/core`에 6개 collector가 전부 포함됐다 (forced-reflow, long-tasks, layout-shift, network, web-vitals, paint). 스택 파싱은 지연 처리되고, forced-reflow는 동기적으로 dirty 추적을 한다.
+```ts
+import { createSourceMapResolver } from '@react-perfscope/core'
 
-**forced-reflow 참고:** `MutationObserver.takeRecords()`를 이용한 동기 dirty 추적으로, 마지막 레이아웃 읽기 이후 DOM이 실제로 변경됐을 때만 신호를 내보낸다. 스택 파싱은 `signal.stack`에 접근할 때까지 미뤄진다.
+const resolver = createSourceMapResolver()
+const original = await resolver.resolve(parsedFrame)
+```
 
-**paint collector 참고:** Phase 2에서는 paint 항목을 크기가 0인 `rect` 플레이스홀더와 함께 내보낸다. 실제 변경 영역 geometry는 Phase 3에서 UI 패키지와 함께 들어온다.
+---
 
-`render` 신호는 곧 나올 `@react-perfscope/react` 패키지(Phase 3)가 담당하고, 아직 내보내지 않는다.
+<a id="한국어"></a>
 
-## Source-map 해석
+# 한국어
 
-`createSourceMapResolver()`는 `//# sourceMappingURL=` 참조 (inline `data:` URI 포함)를 따라가서 source map을 가져오고, 파싱된 결과를 소스 URL 단위로 캐시한 다음, `StackFrame`을 원본 소스 위치로 해석해주는 async resolver를 반환한다. UI에서 번들된 스택 트레이스를 읽을 수 있게 해주는 데 쓰인다.
+`react-perfscope`의 핵심 레코딩 엔진. `Recorder`와 플러그인 방식의 `Collector`를 제공해서 정규화된 성능 신호(forced-reflow, long-tasks, layout-shift, network, web-vitals, paint)를 내보낸다.
 
-```ts
-import { createSourceMapResolver } from '@react-perfscope/core'
+## 설치
 
-const resolver = createSourceMapResolver()
-const original = await resolver.resolve(parsedFrame)
+```sh
+npm install @react-perfscope/core
 ```
 
-source map이 없거나 네트워크 에러 등 어떤 이유로든 실패하면 원본 frame을 그대로 반환한다.
-
-## 예제
+## 사용법
 
 ```ts
 import {
@@ -111,3 +88,14 @@ const result = recorder.stop()
 
 console.log(result.signals)
 ```
+
+## Source-map 해석
+
+`createSourceMapResolver()`는 `//# sourceMappingURL=` 참조(inline `data:` URI 포함)를 따라가서 `StackFrame`을 원본 소스 위치로 해석해주는 async resolver를 반환한다. 덕분에 번들된 스택 트레이스를 읽을 수 있다. 실패하면 원본 frame을 그대로 반환한다.
+
+```ts
+import { createSourceMapResolver } from '@react-perfscope/core'
+
+const resolver = createSourceMapResolver()
+const original = await resolver.resolve(parsedFrame)
+```

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@react-perfscope/core",
-  "version": "0.1.0",
-  "description": "Signal collectors and recorder powering react-perfscope — a zero-config React runtime performance profiler.",
+  "version": "0.1.1",
+  "description": "Recorder and signal collectors for react-perfscope.",
   "keywords": [
     "react",
     "performance",