Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

스토리북 및 크로마틱 자동 배포 워크플로우 추가 셋업 #11

Merged
merged 11 commits into from
Jul 31, 2024

Conversation

froggy1014
Copy link
Collaborator

@froggy1014 froggy1014 commented Jul 30, 2024

PR 타입 ( 하나 이상의 PR 타입을 선택해주세요 )


  • 기능 추가
  • 버그 수정
  • 의존성, 환경 변수, 빌드 관련 코드 업데이트
  • 기타 사소한 수정

개요

질문

  1. 디자인쪽에서 명시한 Color System 같은 경우는 tailwindCSS Theme에 확장할 때, globals.css 에서 변수화 해주는게 일반적인가요?
  2. 그 외 스토리북이 제가 처음인지라.. 세팅에 뭔가 문제가 있을까... 리뷰 부탁드립니다 🙇‍♂️

변경 사항

  1. 스토리북 초기 세팅 및 chromatic에 gitAction으로 CD
  2. Radix UI, TailwindCSS 세팅

@froggy1014 froggy1014 self-assigned this Jul 30, 2024
Copy link

vercel bot commented Jul 30, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
fiesta ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 31, 2024 11:49am

Copy link

💅 ## storybook-URL - https://66a939e10fecfdf69816c066-rfimnvtdbm.chromatic.com/

@froggy1014 froggy1014 added the enhancement New feature or request label Jul 31, 2024
@froggy1014 froggy1014 linked an issue Jul 31, 2024 that may be closed by this pull request
1 task
@froggy1014 froggy1014 merged commit 544665c into develop Jul 31, 2024
3 checks passed
@froggy1014 froggy1014 deleted the feat/storybook-setup branch July 31, 2024 15:07
Copy link
Member

@seokzin seokzin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

잘 봤습니다~ 스토리북에 대해서는 크게 이견 없었어요!

Comment on lines +5 to +11
addons: [
"@storybook/addon-onboarding",
"@storybook/addon-links",
"@storybook/addon-essentials",
"@chromatic-com/storybook",
"@storybook/addon-interactions",
],
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

필수 애드온은 잘 정의되어 있네요!
이외 config 코드도 이견 없습니다~

Comment on lines +4 to +13
const preview: Preview = {
parameters: {
controls: {
matchers: {
color: /(background|color)$/i,
date: /Date$/i,
},
},
},
};
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

제가 emotion으로만 스토리북을 구상 해봤어서 그런데
global이 잘 동작한다면 문제 없어요!
추후 wrapper 컴포넌트가 추가 된다면 renderStory() 메서드를 기반으로 이 부분에서 구현 하시면 돼요~

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@seokzin

Wrapper Component가 추가된다면 어떤 경우인지 혹시 알려주실 수 있나요?

Copy link
Member

@seokzin seokzin Aug 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@froggy1014

Root.tsx 생각하시면 이해하기 편해요~

const ThemeWrapper = ({ children }) => (
  <ThemeProvider theme={theme}>
    <Global styles={global} />
    {children}
  </ThemeProvider>
)

export const decorators = [(renderStory) => <ThemeWrapper>{renderStory()}</ThemeWrapper>]

스토리북에서도 Root 단에 필요한 로직이나 스타일링이 있다면 preview를 JSX 문법으로 활용할 수 있다는 의미였어요!

@@ -9,10 +9,13 @@
"lint": "next lint",
"prepare": "husky",
"cz": "cz",
"formatting": "prettier --write '**/*.{ts,tsx}' && eslint --fix ."
"formatting": "prettier --write '**/*.{ts,tsx}' && eslint --fix .",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P3

사소하지만 prettier를 format, lint를 lint 스크립트로 분리하는 것도 추천드려요!
디버깅 목적으로 둘이 독립적으로 사용되는 경우도 자주 있을 뿐더러, 조금 더 보편적인 방식이라 생각해요 (저의 과거 리서치에 의하면)

추가로 next lint 스크립트도 사용하지 않는다면 제거하거나 eslint로 오버라이딩 하면 좋겠네요!

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@seokzin

호오...! 반영하겠습니다 감사합니다.

Comment on lines +19 to +21
colors: {
"primary-color-01": "var(--primary-color-01)",
"primary-color-02": "var(--primary-color-02)",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P3

제가 emotion으로만 프로젝트를 했어서 그런데
공식문서 토대로 질문 드리면, extend 하위에 color가 있어도 정상 동작 하던가요?
문서에서는 color가 config 객체의 상위 프로퍼티로 설명 되어있길래 여쭤봐요!

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@seokzin

사용자 정의 색상 추가는 extend에 하라고 어디서 본것 같아서.. 추가를 했습니다.

extend 외부에 있는 color에 넣을경우는 이제 그 default 색상들에 오버라이딩이 되는 것 같습니다. ( 물론 키값이 같아야겠지만 )

동작은 잘 됬어가지구.. 그 부분은 놓쳤네요.

일단 그대로 두도록 하겠습니당. 감사합니다.

@froggy1014 froggy1014 mentioned this pull request Aug 5, 2024
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[디자인 시스템] 스토리북 세팅
3 participants