Skip to content

docs: sync READMEs with implementation, export ConsentState from client - #11

Merged
sunwjy merged 1 commit into
mainfrom
docs/readme-sync
Jun 10, 2026
Merged

docs: sync READMEs with implementation, export ConsentState from client#11
sunwjy merged 1 commit into
mainfrom
docs/readme-sync

Conversation

@sunwjy

@sunwjy sunwjy commented Jun 10, 2026

Copy link
Copy Markdown
Owner

Summary

  • README을 17개 플러그인 구현과 전수 대조 검증한 후속 수정 사항입니다
  • 루트 README에 누락됐던 sgtm 플러그인 문서화 (플러그인 테이블, setUser 매핑 테이블, 이벤트 매핑 섹션)
  • Supported Events 테이블에 EventMap(21개)에는 있지만 빠져 있던 5개 이벤트 추가: login, share, view_search_results, add_to_wishlist, view_cart (루트 + core README)
  • @sunwjy/funnel-client에서 ConsentState/ConsentStatus 타입 re-export — 문서화된 setConsent 플러그인 훅을 소비자가 타이핑할 수 있도록
  • Pre-release Backlog 섹션을 TODO로 정리 (완료 항목 제거, API docs 항목만 유지)

Verification

  • pnpm build 5/5, pnpm typecheck 7/7, pnpm test 429/429, pnpm lint 통과

🤖 Generated with Claude Code

…lient

- Add missing sgtm plugin to root README (package description, plugin
  table, setUser mapping table, event mapping section)
- Add 5 missing events (login, share, view_search_results,
  add_to_wishlist, view_cart) to Supported Events tables in root and
  core READMEs, matching the 21-event EventMap
- Re-export ConsentState/ConsentStatus types from @sunwjy/funnel-client
  so the documented setConsent plugin hook is typeable by consumers
- Replace Pre-release Backlog with TODO, dropping completed items

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 97.24% 918 / 944
🔵 Statements 96.56% 1067 / 1105
🔵 Functions 98.94% 187 / 189
🔵 Branches 91.59% 839 / 916
File Coverage
File Stmts Branches Functions Lines Uncovered Lines
Changed Files
packages/client/src/index.ts 100% 100% 100% 100%
Generated in workflow #27 for commit f8b6146 by the Vitest Coverage Report Action

@sunwjy
sunwjy merged commit bec809a into main Jun 10, 2026
1 check passed
@sunwjy
sunwjy deleted the docs/readme-sync branch June 10, 2026 14:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant