Skip to content

데모 'Show code' 스냅샷이 데모 전용 보일러플레이트(색상 팔레트·useMemo)까지 그대로 노출 #59

Description

@Malloc72P

페르소나 리뷰(적대적 검증 통과)에서 정리된 항목입니다.

관점: 일반 사용자(Docs 사이트) · 구분: 개선 · 심각도: low · 난이도: 중간

현상

Show code로 보이는 DUMMY_CODE는 데모 .tsx 파일 전체를 문자열화한 것이다. 예컨대 nations2.demo.tsx는 pink/blue/gray 색상 배열, colorThemes 매핑, theme/map props 분기 등 데모 UI를 위한 코드가 큰 비중을 차지한다. 방문자는 'HyperGlobe를 쓰는 핵심 코드'와 '데모용 부수 코드'를 구분하기 어렵다.

근거

packages/hyperglobe/scripts/prepare-storybook-internal/build-dummy-code.js:16-24 (데모 파일 전체를 문자열화) / nations2.demo.tsx:4-49 (데모 전용 팔레트/테마 코드)

권고

데모마다 '최소 사용 예시' 스니펫을 별도로 제공하거나, 가이드(hyperglobe.guide.mdx 등)의 짧은 예제를 데모와 함께 노출해 핵심 코드를 먼저 보여준다.

검증 메모

발견 자체는 정확하나 한 가지 정정/보강이 필요하다. 권고("데모마다 최소 사용 예시를 별도 제공")는 이미 부분적으로 충족돼 있다. Components/HyperGlobe 등 컴포넌트 스토리(hyperglobe.stories.tsx)는 DUMMY_CODE를 쓰지 않고 Storybook 기본 source 생성으로 데모 보일러플레이트 없는 최소 스니펫을 이미 보여준다. 따라서 '핵심 코드를 먼저 보여주는 최소 예시'는 새로 만들 필요가 없고, 이미 존재하는 Components 문서를 Demo 페이지에서 더 잘 안내(링크/Canvas 노출)하면 된다. 또한 DUMMY_CODE는 src 상대경로를 @hyperglobe/core로 치환해주므로 import 구문은 그대로 복사 가능한 상태다(완전한 노이즈는 아님).

Metadata

Metadata

Assignees

No one assigned

    Labels

    review페르소나 리뷰에서 도출된 항목tech-debt유지보수성/빌드/테스트 기술부채

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions