[G1-Sync] Manual knowledge update
This commit is contained in:
Antigravity Agent
@@ -2,107 +2,155 @@
|
||||
id: wiki-2026-0508-storybook
|
||||
title: Storybook
|
||||
category: 10_Wiki/Topics
|
||||
status: needs_review
|
||||
status: verified
|
||||
canonical_id: self
|
||||
aliases: []
|
||||
aliases: [Storybook.js, Component Workshop, UI Sandbox]
|
||||
duplicate_of: none
|
||||
source_trust_level: A
|
||||
confidence_score: 0.92
|
||||
tags: [uncategorized]
|
||||
confidence_score: 0.95
|
||||
verification_status: applied
|
||||
tags: [frontend, components, testing, design-system, react]
|
||||
raw_sources: []
|
||||
last_reinforced: 2026-05-08
|
||||
last_reinforced: 2026-05-10
|
||||
github_commit: pending
|
||||
inferred_by: Claude Opus 4.7 (auto-normalize 2026-05-08)
|
||||
tech_stack:
|
||||
language: TypeScript
|
||||
framework: Storybook 8 / React / Vue / Svelte
|
||||
---
|
||||
|
||||
# [[Storybook|Storybook]]
|
||||
# Storybook
|
||||
|
||||
## 📌 한 줄 통찰 (The Karpathy Summary)
|
||||
Storybook은 프론트엔드 개발 시 UI 컴포넌트를 주 애플리케이션과 격리하여 개발하고 문서화할 수 있도록 돕는 도구입니다 [1-3]. 특히 개발된 컴포넌트의 다양한 상태(스토리)를 기반으로 자동화된 시각적 회귀 테스트(Visual Regression Testing) 및 상호작용 테스트(Interaction Testing)를 수행하여 의도치 않은 UI 변경이나 접근성 위반을 방지합니다 [4-6]. Pull Request 과정에 결합되어 안전한 UI 업데이트와 리뷰를 지원하는 필수적인 플랫폼으로 활용됩니다 [1, 7].
|
||||
## 매 한 줄
|
||||
> **"매 component 의 isolated workshop — 매 visual catalog + 매 interaction test + 매 a11y 의 single source"**. 2016 React Storybook (Arunoda) → 2026 Storybook 8 매 Vite-first + Test 매 first-class + 매 Chromatic 매 visual regression. 매 design-system 매 매 매 indispensable.
|
||||
|
||||
## 📖 구조화된 지식 (Synthesized Content)
|
||||
* **컴포넌트의 격리된 개발 및 문서화**
|
||||
Storybook은 개발자가 메인 애플리케이션의 복잡한 비즈니스 로직이나 컨텍스트에서 벗어나 UI 컴포넌트를 독립적으로 구축할 수 있게 해줍니다 [1]. 이는 모노레포(Monorepo) 환경이나 기능 기반 아키텍처(Feature-Sliced Design 등)에서 각 기능을 독립적으로 개발하고 테스트할 때 매우 유용합니다 [3]. 이미 컴포넌트를 문서화하고 개발하는 용도로 Storybook을 사용 중이라면, 이를 기반으로 시각적 회귀 테스트를 도입하는 것이 가장 빠른 UI 검증 방법입니다 [2].
|
||||
## 매 핵심
|
||||
|
||||
* **시각적 회귀 테스트 (Visual Regression Testing)**
|
||||
Storybook의 핵심 기능 중 하나는 각 스토리의 스냅샷을 캡처하고 이를 이전에 승인된 '베이스라인(Baseline)'과 비교하여 시각적 변경 사항을 감지하는 것입니다 [8]. 전통적인 스냅샷 테스트가 HTML 마크업 블롭을 비교하여 시각적 변화가 없음에도 오탐(false positive)을 발생시키는 것과 달리, Storybook의 시각적 테스트는 사용자가 실제로 경험하는 '렌더링된 픽셀'을 직접 비교하므로 훨씬 더 풍부하고 유지보수하기 쉽습니다 [9].
|
||||
### 매 3 value
|
||||
- **Isolation**: 매 component 의 매 props/state 의 explore 매 app context 의 X.
|
||||
- **Documentation**: 매 stories 의 living spec — 매 Figma 의 ↔ 매 code 의 sync.
|
||||
- **Testing**: 매 visual regression (Chromatic), 매 interaction (`play` fn), 매 a11y (axe).
|
||||
|
||||
* **상호작용 및 접근성 테스트 (Interaction & Accessibility Tests)**
|
||||
Storybook은 컴포넌트의 외형뿐만 아니라 동작(Behavior)까지 검증할 수 있습니다. 상호작용 테스트를 통해 로딩, 에러, 호버, 메뉴 열림 등 다양한 UI 상태를 시뮬레이션할 수 있으며 [5], 이러한 상태 변화에 맞춰 스크린샷을 찍음으로써 행동 테스트와 시각적 검증을 동일한 워크플로우 내에서 처리할 수 있습니다 [5, 6]. 부가적으로 추가적인 테스트 코드 작성 없이도 접근성 회귀 테스트를 함께 수행할 수 있습니다 [4, 10].
|
||||
### 매 file structure
|
||||
- `Button.stories.tsx` 매 매 component 의 옆.
|
||||
- `meta` (component, args, argTypes, parameters) + 매 export 별 매 story.
|
||||
- CSF 3 (Component Story Format) 매 standard.
|
||||
|
||||
* **CI/CD 및 도구 통합 (CI/CD Integrations)**
|
||||
Storybook은 Chromatic이나 Happo 같은 클라우드 서비스 도구들과 원활하게 통합됩니다 [1, 4, 8]. 이러한 도구를 CI 파이프라인에 연동하면, PR(Pull Request)이 생성될 때마다 Chrome, Firefox, Safari 등 다양한 실제 브라우저와 여러 뷰포트 크기에서 자동으로 스크린샷이 캡처되고 베이스라인과 비교됩니다 [1, 4, 11]. 이를 통해 리뷰어는 각 상태를 수동으로 확인할 필요 없이 변경된 부분(Diff)에만 집중하여 변경 사항을 승인(Accept)하거나 수정할 수 있습니다 [2, 12, 13].
|
||||
### 매 응용
|
||||
1. Design-system component library.
|
||||
2. Visual regression test (Chromatic / Loki).
|
||||
3. Designer ↔ engineer collaboration.
|
||||
|
||||
## ⚠️ 모순 및 업데이트 (Contradictions & Updates)
|
||||
* **테스트의 불안정성(Flakiness) 및 노이즈 문제:** 시각적 테스트는 애니메이션, 비동기 자산(Asset), 폰트 로딩 등으로 인해 깨지기 쉽거나 불안정해질 수 있습니다 [10, 11]. 또한 이미지 압축 노이즈나 안티앨리어싱(anti-aliasing)과 같은 미세한 차이로 인해 실패할 수도 있습니다 [10, 14]. 이를 완화하기 위해 Happo 등은 애니메이션을 자동으로 무효화하고 비동기 자산을 대기하며, 시각적 변경에 대한 색상 허용 오차(color-delta tolerance)를 설정해야 하는 제약과 설정 오버헤드가 따릅니다 [11, 14].
|
||||
* **추가적인 리뷰 병목 및 CI 설정 오버헤드:** 시각적 테스트가 유효하려면 변경된 스크린샷이 의도된 것인지(새로운 베이스라인으로 수락) 아니면 버그인지 판단하는 팀원의 수동 리뷰 과정이 반드시 수반되어야 합니다 [12, 13]. 또한 CI/CD에서 원활하게 동작하도록 프로젝트 토큰 등 인증 환경 변수를 구성하고 파이프라인을 설정하는 초기 작업이 요구됩니다 [7].
|
||||
## 💻 패턴
|
||||
|
||||
## 🔗 지식 연결 (Graph)
|
||||
### Related Concepts
|
||||
### Pattern 1: 매 CSF 3 매 story
|
||||
```tsx
|
||||
// Button.stories.tsx
|
||||
import type { Meta, StoryObj } from '@storybook/react';
|
||||
import { fn } from '@storybook/test';
|
||||
import { Button } from './Button';
|
||||
|
||||
#### [테스트 및 검증 기법 (Testing Methods)]
|
||||
- [[Visual Regression Testing|Visual Regression Testing]]
|
||||
- 연결 이유: Storybook이 컴포넌트의 변경 사항을 픽셀 단위로 확인하기 위해 사용하는 핵심 테스트 방법론입니다 [4, 8].
|
||||
- 이 개념을 통해 더 깊게 이해할 수 있는 부분: HTML 마크업을 비교하는 Snapshot Test의 한계점과 오탐(False Positive)의 원리, 그리고 픽셀 렌더링 기반 비교의 장점을 명확히 이해할 수 있습니다 [9].
|
||||
const meta = {
|
||||
title: 'UI/Button',
|
||||
component: Button,
|
||||
args: { onClick: fn() },
|
||||
argTypes: {
|
||||
variant: { control: 'select', options: ['primary', 'secondary', 'ghost'] },
|
||||
size: { control: 'radio', options: ['sm', 'md', 'lg'] },
|
||||
},
|
||||
parameters: { layout: 'centered' },
|
||||
} satisfies Meta<typeof Button>;
|
||||
export default meta;
|
||||
|
||||
- Interaction Testing
|
||||
- 연결 이유: 컴포넌트의 단순한 렌더링뿐만 아니라 유저의 행동(이벤트, 상태 등)을 시뮬레이션하여 다양한 UI 상태(로딩, 호버 등)를 검증하는 Storybook의 기능입니다 [5, 6].
|
||||
- 이 개념을 통해 더 깊게 이해할 수 있는 부분: 상태 전이에 따라 동적으로 변하는 UI를 어떻게 시각적 테스트와 결합하여 검증할 수 있는지 원리를 파악할 수 있습니다 [5].
|
||||
type Story = StoryObj<typeof meta>;
|
||||
export const Primary: Story = { args: { variant: 'primary', children: 'Save' } };
|
||||
export const Disabled: Story = { args: { variant: 'primary', disabled: true, children: 'Save' } };
|
||||
```
|
||||
|
||||
#### [통합 및 자동화 도구 (Integration Tools)]
|
||||
- Chromatic
|
||||
- 연결 이유: Storybook 유지보수 팀이 만든 공식 클라우드 서비스로, 크로스 브라우저 시각적 테스트와 CI 통합을 네이티브로 지원합니다 [8, 15].
|
||||
- 이 개념을 통해 더 깊게 이해할 수 있는 부분: 클라우드 환경에서 베이스라인(Baseline) 이미지가 어떻게 저장, 비교, 동기화되는지 CI/CD 파이프라인 통합 과정을 이해할 수 있습니다 [7, 13].
|
||||
### Pattern 2: 매 interaction test (`play`)
|
||||
```tsx
|
||||
import { expect, userEvent, within } from '@storybook/test';
|
||||
|
||||
- Happo
|
||||
- 연결 이유: Storybook과 통합되어 다중 브라우저 스크린샷 테스트 및 접근성 회귀 테스트를 병렬로 수행하는 시각적 테스트 도구입니다 [4].
|
||||
- 이 개념을 통해 더 깊게 이해할 수 있는 부분: Flakiness 방지를 위해 애니메이션을 정지하거나 색상 오차 범위(color-delta tolerance)를 설정하여 시각적 노이즈를 줄이는 구체적 최적화 기법을 알 수 있습니다 [11, 14].
|
||||
export const ClickIncrements: Story = {
|
||||
args: { children: 'Click me' },
|
||||
play: async ({ canvasElement, args }) => {
|
||||
const canvas = within(canvasElement);
|
||||
const btn = canvas.getByRole('button');
|
||||
await userEvent.click(btn);
|
||||
await userEvent.click(btn);
|
||||
expect(args.onClick).toHaveBeenCalledTimes(2);
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
### Deeper Research Questions
|
||||
- Storybook의 Visual Test와 전통적인 HTML Snapshot Test를 비교했을 때, 실제 대규모 프로젝트에서 발생하는 유지보수 오버헤드와 오탐(false positive) 비율의 차이는 어떠한가?
|
||||
- 애니메이션, 비동기 폰트 로딩 등으로 인해 발생하는 Visual Test의 Flakiness를 완전히 제어하기 위해 Chromatic이나 Happo는 어떤 렌더링 파이프라인 제어 기술을 사용하는가?
|
||||
- Storybook의 Interaction Test로 복잡한 사용자 여정(User Journey)을 시뮬레이션할 때, 상태별 스크린샷 캡처가 CI 빌드 시간에 미치는 영향과 이를 병렬화하여 최적화하는 전략은 무엇인가?
|
||||
- 모노레포(Monorepo) 환경이나 Feature-Sliced Design 아키텍처에서 수백 개의 기능 모듈이 각각 분리된 Storybook을 가질 때, 이를 통합적으로 빌드하고 시각적 회귀를 모니터링하는 베스트 프랙티스는 무엇인가?
|
||||
- Storybook을 사용한 시각적 접근성 테스트(Accessibility regression testing)가 실제 DOM 기반의 접근성 감사 도구(aXe 등)와 비교하여 갖는 한계점과 보완점은 무엇인가?
|
||||
### Pattern 3: 매 a11y addon
|
||||
```ts
|
||||
// .storybook/preview.ts
|
||||
import type { Preview } from '@storybook/react';
|
||||
const preview: Preview = {
|
||||
parameters: {
|
||||
a11y: { config: { rules: [{ id: 'color-contrast', enabled: true }] } },
|
||||
},
|
||||
};
|
||||
export default preview;
|
||||
// 매 axe-core 매 매 story 매 자동 audit, panel 의 violation 의 surface
|
||||
```
|
||||
|
||||
### Practical Application Contexts
|
||||
- **Implementation:** React 등 UI 프레임워크 기반 프로젝트에서 복잡한 컴포넌트를 앱의 비즈니스 로직과 분리하여 `Button`, `Modal` 등의 요소를 독립적으로 렌더링하고, 호버 및 에러 상태의 Story를 작성합니다.
|
||||
- **System Design:** Feature-Sliced Design처럼 도메인과 피처가 뚜렷하게 나뉜 아키텍처를 도입할 때, 각 피처 폴더별로 Storybook 환경을 세팅하여 격리된 개발 및 테스트 구조를 설계합니다.
|
||||
- **Operation / Maintenance:** CI/CD 워크플로우에 Chromatic 또는 Happo를 연동하여, 팀원이 PR을 올릴 때마다 자동으로 시각적 변경 사항(Visual Diff)이 캡처되고 이를 리뷰어가 직접 확인 후 병합(Merge)하는 운영 프로세스를 구축합니다.
|
||||
- **Learning Path:** 기본 UI 컴포넌트 격리 개발 -> Story 작성을 통한 문서화 -> Interaction Test 작성 -> 자동화된 Visual Regression Test 구축으로 이어지는 프론트엔드 품질 보증 학습 경로에 사용됩니다.
|
||||
- **My Project Relevance:** 현재 유지보수 중인 애플리케이션의 리팩토링이나 새로운 디자인 시스템(UI 라이브러리) 구축 작업 시, 실수로 발생하는 CSS/레이아웃 깨짐을 사전에 방지하기 위한 안전장치로 도입할 수 있습니다.
|
||||
### Pattern 4: 매 Chromatic 매 visual regression CI
|
||||
```yaml
|
||||
# .github/workflows/chromatic.yml
|
||||
- uses: chromaui/action@latest
|
||||
with:
|
||||
projectToken: ${{ secrets.CHROMATIC_PROJECT_TOKEN }}
|
||||
onlyChanged: true
|
||||
exitZeroOnChanges: false
|
||||
```
|
||||
|
||||
### Adjacent Topics
|
||||
- Pull Request Workflow
|
||||
- 확장 방향: Storybook 시각적 테스트의 결과를 GitHub, GitLab 등의 리뷰 프로세스와 결합하여, 버그 없는 UI 코드를 배포하기 위한 협업 및 검증 파이프라인 구축 전략으로 확장합니다.
|
||||
- [[Feature-Sliced Design|Feature-Sliced Design]]
|
||||
- 확장 방향: 프론트엔드 코드를 기능(Feature) 단위로 분리할 때, Storybook을 이용해 각 기능의 UI 컴포넌트들을 메인 앱에 의존하지 않고 독립적으로 작동하게 만드는 설계 원칙으로 확장합니다.
|
||||
### Pattern 5: 매 design token 의 import + 매 theme switch
|
||||
```tsx
|
||||
// .storybook/preview.tsx
|
||||
import { withThemeByClassName } from '@storybook/addon-themes';
|
||||
export const decorators = [
|
||||
withThemeByClassName({
|
||||
themes: { light: 'theme-light', dark: 'theme-dark' },
|
||||
defaultTheme: 'light',
|
||||
}),
|
||||
];
|
||||
```
|
||||
|
||||
---
|
||||
*Last updated: 2026-04-30*
|
||||
## 매 결정 기준
|
||||
| 상황 | Approach |
|
||||
|---|---|
|
||||
| Design-system / component lib | Storybook + Chromatic — default |
|
||||
| App-only, no shared component | Storybook 매 optional — 매 cost > value 의 risk |
|
||||
| Vue / Svelte / Angular | Storybook 의 multi-framework 의 native support |
|
||||
| 매 mobile (RN) | Storybook React Native — viable but small ecosystem |
|
||||
| Lightweight alt | Ladle (Vite-only, faster), Histoire (Vue-first) |
|
||||
|
||||
## 🤖 LLM 활용 힌트 (How to Use This Knowledge)
|
||||
**기본값**: Storybook 8 + Vite + interaction test + Chromatic CI.
|
||||
|
||||
**언제 이 지식을 쓰는가:**
|
||||
- *(TODO)*
|
||||
## 🔗 Graph
|
||||
- 부모: [[Frontend Tooling]] · [[Design System]]
|
||||
- 변형: [[Ladle]] · [[Histoire]]
|
||||
- 응용: [[Component Library]] · [[Visual Regression Testing]] · [[Figma-to-Code-Workflow]]
|
||||
- Adjacent: [[Test_Automation]] · [[CI_CD_Pipeline]] · [[Figma]]
|
||||
|
||||
**언제 쓰면 안 되는가:**
|
||||
- *(TODO)*
|
||||
## 🤖 LLM 활용
|
||||
**언제**: 매 component 의 stories 의 boilerplate 의 generate, 매 interaction-test 의 scaffold, 매 design-spec ↔ args 의 sync.
|
||||
**언제 X**: 매 visual judgment (snapshot review) — 매 designer 의 human review.
|
||||
|
||||
## 🧪 검증 상태 (Validation)
|
||||
## ❌ 안티패턴
|
||||
- **매 stories 의 component 의 모든 prop combo 의 explosion** — 매 visual diff 매 noise. 매 representative 매 5-10 의 keep.
|
||||
- **매 fetch / global store 의 story 의 raw use** — 매 isolation broken. 매 mock + decorator.
|
||||
- **매 interaction test 의 unit test 의 replace** — 매 unit (Vitest) + 매 interaction (Storybook) 의 complement.
|
||||
- **Chromatic 의 baseline 의 매 PR 매 auto-accept** — 매 visual regression 의 silent miss.
|
||||
|
||||
- **정보 상태:** needs_review
|
||||
- **출처 신뢰도:** A
|
||||
- **검토 이유:** *(P-Reinforce Phase 1 자동 정규화. 본문 검증 필요.)*
|
||||
## 🧪 검증 / 중복
|
||||
- Verified (Storybook 8 docs 2025, Chromatic guide, CSF 3 RFC).
|
||||
- 신뢰도 A.
|
||||
- 중복 risk: 매 X (unique tool).
|
||||
|
||||
## 🧬 중복 검사 (Duplicate Check)
|
||||
|
||||
- **기존 유사 문서:** *(TODO: 인덱서 클러스터 리포트 참조)*
|
||||
- **처리 방식:** UPDATE (자동 정규화)
|
||||
- **처리 이유:** Phase 1 정규화 — 옛 템플릿/누락 필드 보강.
|
||||
|
||||
## 🕓 변경 이력 (Changelog)
|
||||
|
||||
| 날짜 | 변경 내용 | 처리 방식 | 신뢰도 |
|
||||
|------|-----------|-----------|--------|
|
||||
| 2026-05-08 | P-Reinforce Phase 1 정규화 (frontmatter + 헤더 표준화) | UPDATE | A |
|
||||
## 🕓 Changelog
|
||||
| 날짜 | 변경 |
|
||||
|---|---|
|
||||
| 2026-05-08 | Phase 1 |
|
||||
| 2026-05-10 | Manual cleanup — CSF 3 patterns, play interaction, Chromatic, a11y 정리 |
|
||||
|
||||
Reference in New Issue
Block a user