@pygmalionjs/pygmalion 0.2.11 → 0.2.12

package/README.ko.md

@@ -37,23 +37,27 @@ npm install --save-dev @pygmalionjs/pygmalion
 호스트 애플리케이션에 `pygmalion.config.ts`를 만드세요.
 
 ```ts
-import path from 'node:path';
-import { definePygmalionProject } from '@pygmalionjs/pygmalion/vite';
+import path from "node:path";
+import { definePygmalionProject } from "@pygmalionjs/pygmalion/vite";
 
 const appRoot = import.meta.dirname;
-const projectRoot = path.resolve(appRoot, '..');
+const projectRoot = path.resolve(appRoot, "..");
 
 export default definePygmalionProject({
   configRoot: appRoot,
   projectRoot,
   appRoot,
-  appDirectory: 'frontend',
-  sourceDirectory: 'src',
-  source: { remote: 'origin', branch: 'dev' },
-  mirrorRoot: path.resolve(projectRoot, '..', 'app-dev-view'),
+  appDirectory: "frontend",
+  sourceDirectory: "src",
+  source: { remote: "origin", branch: "dev" },
+  mirrorRoot: path.resolve(projectRoot, "..", "app-dev-view"),
   inventory: {
-    script: path.join(appRoot, 'scripts', 'generate-pygmalion-inventory.mjs'),
+    script: path.join(appRoot, "scripts", "generate-pygmalion-inventory.mjs"),
     outputRoot: appRoot,
+    outputs: [
+      "src/generated/design-registry.ts",
+      "src/generated/design-inventory.ts",
+    ],
   },
   inspect: {
     normalizeValue(property, value) {
@@ -63,11 +67,15 @@ export default definePygmalionProject({
 });
 ```
 
+`inventory.outputs`에는 애플리케이션 루트 기준으로 생성기가 소유하는 경로만
+등록합니다. Pygmalion은 전용 미러의 리비전을 전환하기 전에 이 경로만
+복구하며, 그 밖의 변경이 있으면 기존처럼 동기화를 중단합니다.
+
 호스트의 Vite 설정에 통합 플러그인을 추가하세요.
 
 ```ts
-import { createPygmalionVitePlugins } from '@pygmalionjs/pygmalion/vite';
-import pygmalionConfig from './pygmalion.config';
+import { createPygmalionVitePlugins } from "@pygmalionjs/pygmalion/vite";
+import pygmalionConfig from "./pygmalion.config";
 
 export default defineConfig({
   plugins: [react(), ...createPygmalionVitePlugins(pygmalionConfig)],
@@ -97,6 +105,24 @@ export default defineConfig({
 지원합니다. 각 프레임이 항상 같은 애플리케이션 상태를 재현하도록 결정적인
 레시피와 assertion을 사용하세요.
 
+## 캡처 산출물 생명주기
+
+범용 캡처 기능은 `@pygmalionjs/pygmalion/storyboard`에서 가져옵니다.
+Pygmalion은 격리된 브라우저 컨텍스트, 제한된 병렬 스케줄링, 비활성 DOM
+스냅샷, 스크린샷, QA 진단, 압축된 버전 산출물, 정확한 리비전 검증, 원자적
+산출물 교체를 관리합니다. Vite 통합은 현재 에디터의 namespace와 소스
+리비전에 정확히 일치하는 산출물만 제공합니다.
+
+호스트 애플리케이션은 라우트, 환경 preset, 목 어댑터, 상호작용 recipe,
+assertion만 제공합니다. 도메인별 네트워크 fixture는 호스트 hook에서 설치할
+수 있지만 브라우저나 산출물 생명주기를 별도로 구현하면 안 됩니다.
+
+산출물 v3는 등록한 모든 프레임을 `ready`,
+`rendered-with-qa-failure`, `capture-error` 중 하나로 보존합니다. QA 실패는
+CI를 실패 상태로 유지하면서 마지막으로 안정화된 DOM과 스크린샷을 남길 수
+있습니다. 따라서 엄격 캡처가 실패해도 이전 리비전의 산출물이 조용히 계속
+활성화되지 않습니다.
+
 ## 편집 흐름
 
 1. **Screens**를 엽니다. 프레임을 클릭하지 않아도 프리뷰 준비를 시작합니다.

package/README.md

@@ -37,23 +37,27 @@ npm install --save-dev @pygmalionjs/pygmalion
 Create `pygmalion.config.ts` in the host application:
 
 ```ts
-import path from 'node:path';
-import { definePygmalionProject } from '@pygmalionjs/pygmalion/vite';
+import path from "node:path";
+import { definePygmalionProject } from "@pygmalionjs/pygmalion/vite";
 
 const appRoot = import.meta.dirname;
-const projectRoot = path.resolve(appRoot, '..');
+const projectRoot = path.resolve(appRoot, "..");
 
 export default definePygmalionProject({
   configRoot: appRoot,
   projectRoot,
   appRoot,
-  appDirectory: 'frontend',
-  sourceDirectory: 'src',
-  source: { remote: 'origin', branch: 'dev' },
-  mirrorRoot: path.resolve(projectRoot, '..', 'app-dev-view'),
+  appDirectory: "frontend",
+  sourceDirectory: "src",
+  source: { remote: "origin", branch: "dev" },
+  mirrorRoot: path.resolve(projectRoot, "..", "app-dev-view"),
   inventory: {
-    script: path.join(appRoot, 'scripts', 'generate-pygmalion-inventory.mjs'),
+    script: path.join(appRoot, "scripts", "generate-pygmalion-inventory.mjs"),
     outputRoot: appRoot,
+    outputs: [
+      "src/generated/design-registry.ts",
+      "src/generated/design-inventory.ts",
+    ],
   },
   inspect: {
     normalizeValue(property, value) {
@@ -63,11 +67,15 @@ export default definePygmalionProject({
 });
 ```
 
+`inventory.outputs` lists generator-owned paths relative to the application root. Pygmalion
+restores only these paths in its dedicated mirror before switching revisions, while any other
+mirror change still stops synchronization.
+
 Add the integration plugins to the host Vite configuration:
 
 ```ts
-import { createPygmalionVitePlugins } from '@pygmalionjs/pygmalion/vite';
-import pygmalionConfig from './pygmalion.config';
+import { createPygmalionVitePlugins } from "@pygmalionjs/pygmalion/vite";
+import pygmalionConfig from "./pygmalion.config";
 
 export default defineConfig({
   plugins: [react(), ...createPygmalionVitePlugins(pygmalionConfig)],
@@ -97,6 +105,24 @@ Screen recipes support `click`, `fill`, `check`, `press`, `wait`, and `storage`
 steps. Use deterministic recipes and assertions so each frame represents a
 repeatable application state.
 
+## Capture artifact lifecycle
+
+Import the reusable capture primitives from
+`@pygmalionjs/pygmalion/storyboard`. Pygmalion owns isolated browser contexts,
+bounded scheduling, inert DOM snapshots, screenshots, QA diagnostics, compact
+versioned artifacts, exact revision validation, and atomic artifact
+publication. The Vite integration serves only an artifact whose namespace and
+source revision match the active editor.
+
+The host application supplies routes, environment presets, mock adapters,
+interaction recipes, and assertions. A host hook may install domain-specific
+network fixtures, but it must not fork the browser or artifact lifecycle.
+
+Artifact v3 preserves every registered frame with one explicit outcome:
+`ready`, `rendered-with-qa-failure`, or `capture-error`. QA failures can retain
+their last stable DOM and screenshot while CI remains red. A failed strict
+capture therefore cannot silently leave an older artifact active.
+
 ## Editing workflow
 
 1. Open **Screens**. Preview warm-up starts without requiring frame clicks.