Chore/storybook theme #97
Conversation
froggy1014
requested review from
kimdaeyeobbb,
hy57in,
developerjhp,
bae-sh,
noahluftyang,
heeji289,
synuns,
yeojini and
SEMIN-97
as code owners
|
|
Warning There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure. 🔧 eslint
.storybook/main.tsOops! Something went wrong! :( ESLint: 9.17.0 ESLint couldn't find an eslint.config.(js|mjs|cjs) file. From ESLint v9.0.0, the default configuration file is now eslint.config.js. https://eslint.org/docs/latest/use/configure/migration-guide If you still have problems after following the migration guide, please stop by 워크스루이 풀 리퀘스트는 Storybook 구성을 개선하고 구성 요소의 카테고리화를 재구조화하는 데 중점을 둡니다. 변경 사항
제안된 라벨
제안된 리뷰어
시 (토끼의 노래)
Finishing Touches
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Codecov ReportAll modified and coverable lines are covered by tests ✅ |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (3)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yamlpublic/assets/favicon.icois excluded by!**/*.icopublic/assets/sipe_brand_logo.pngis excluded by!**/*.png
📒 Files selected for processing (20)
.storybook/main.ts(2 hunks).storybook/manager.ts(1 hunks).templates/component/src/Component.stories.tsx(1 hunks)docs/introduction.mdx(1 hunks)package.json(1 hunks)packages/Input/src/Input.stories.tsx(1 hunks)packages/avatar/src/Avatar.stories.tsx(3 hunks)packages/badge/src/Badge.stories.tsx(1 hunks)packages/button/src/Button.stories.tsx(1 hunks)packages/card/src/Card.stories.tsx(1 hunks)packages/divider/src/Divider.stories.tsx(1 hunks)packages/flex/src/Flex.stories.tsx(1 hunks)packages/icon/src/Icons.stories.tsx(4 hunks)packages/radio-group/src/RadioGroup.stories.tsx(1 hunks)packages/skeleton/src/Skeleton.stories.tsx(1 hunks)packages/switch/src/Switch.stories.tsx(1 hunks)packages/tokens/src/Tokens.stories.tsx(1 hunks)packages/tooltip/src/Tooltip.stories.tsx(1 hunks)packages/typography/src/Typography.stories.tsx(1 hunks)pnpm-workspace.yaml(1 hunks)
✅ Files skipped from review due to trivial changes (16)
- .storybook/manager.ts
- packages/card/src/Card.stories.tsx
- .templates/component/src/Component.stories.tsx
- packages/switch/src/Switch.stories.tsx
- packages/tokens/src/Tokens.stories.tsx
- packages/divider/src/Divider.stories.tsx
- packages/Input/src/Input.stories.tsx
- packages/flex/src/Flex.stories.tsx
- packages/badge/src/Badge.stories.tsx
- packages/avatar/src/Avatar.stories.tsx
- packages/skeleton/src/Skeleton.stories.tsx
- docs/introduction.mdx
- packages/icon/src/Icons.stories.tsx
- packages/radio-group/src/RadioGroup.stories.tsx
- packages/typography/src/Typography.stories.tsx
- packages/tooltip/src/Tooltip.stories.tsx
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: chromatic
🔇 Additional comments (4)
.storybook/main.ts (2)
5-5: 문서화 기능이 확장되었습니다.docs 디렉토리의 MDX 파일을 스토리북에 포함시켜 문서화 기능이 향상되었습니다.
18-20: 파비콘 경로를 확인해주세요.파비콘 경로가 올바르게 설정되어 있는지 확인이 필요합니다.
✅ Verification successful
파비콘 경로가 정상적으로 설정되어 있습니다.
파비콘 파일이
public/assets/favicon.ico에 존재하며, Storybook 설정의 상대 경로(../public/assets/favicon.ico)가 올바르게 구성되어 있습니다.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # 파비콘 파일의 존재 여부 확인 test -f public/assets/favicon.ico && echo "파비콘 파일이 존재합니다" || echo "파비콘 파일이 없습니다"Length of output: 72
packages/button/src/Button.stories.tsx (1)
5-5: 컴포넌트 구조가 개선되었습니다.'Components' 네임스페이스 아래에 버튼 컴포넌트를 배치하여 스토리북의 구조가 더 체계적으로 개선되었습니다.
package.json (1)
16-16: 사용하지 않는 의존성을 확인해주세요.@clack/prompts 패키지가 여전히 의존성에 포함되어 있지만, 실제로 사용되고 있는지 확인이 필요합니다.
✅ Verification successful
@clack/prompts 패키지는 컴포넌트 생성 CLI에서 활발히 사용 중입니다.
scripts/createComponent.ts 파일에서 CLI 인터페이스 구현을 위해 intro, outro, spinner, text, isCancel 등의 기능을 적극적으로 활용하고 있습니다. 해당 의존성은 필요한 패키지임이 확인되었습니다.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # @clack/prompts 패키지의 사용 여부 확인 rg -l "@clack/prompts"Length of output: 77
Script:
#!/bin/bash # scripts/createComponent.ts 파일에서 @clack/prompts의 사용 패턴 확인 cat scripts/createComponent.tsLength of output: 3958
| "@commitlint/cli": "^19.6.1", | ||
| "@commitlint/config-conventional": "^19.6.0", | ||
| "@commitlint/cz-commitlint": "^19.6.1", | ||
| "@commitlint/types": "^19.5.0", | ||
| "@clack/prompts": "^0.9.0", | ||
| "@storybook/addon-docs": "^8.4.7", |
There was a problem hiding this comment.
🛠️ Refactor suggestion
스토리북 패키지 버전 관리 방식을 통일해주세요.
일부 스토리북 패키지는 특정 버전(^8.4.7)을 사용하고 있고, 다른 패키지들은 catalog:를 참조하고 있습니다. 패키지 버전 관리 방식을 통일하여 유지보수성을 높이는 것이 좋습니다.
- "@storybook/addon-docs": "^8.4.7",
+ "@storybook/addon-docs": "catalog:",
- "@storybook/manager-api": "^8.4.7",
+ "@storybook/manager-api": "catalog:",
- "@storybook/theming": "^8.4.7",
+ "@storybook/theming": "catalog:",Also applies to: 26-26, 30-30
* chore(asset): add favicon, logo assets * chore(storybook): add theme, manager storybook core API, Components * style(storybook): add sipe branding in storybook * style(storybook): add favicon * chore(storybook): add addon-docs, react, react-dom for storybook mdx * docs(storybook): add introduction mdx * docs(storybook): rename concept -> intro * docs(storybook): add category for all components * chore(storybook): remove react and react-dom dependencies * style(storybook): update secondary color and selected bar color * chore(asset): rename sipe logo file * chore(storybook): update brandImage file path * chore(storybook): remove unused style
Changes
Visuals
Checklist
Additional Discussion Points
Summary by CodeRabbit
Storybook 구성
Components/[ComponentName]으로 재구성의존성 업데이트
^8.4.7로 업그레이드문서화