Storybook adjustments #245
Conversation
deboracosilveira
requested review from
anicioalexandre and
priscilladeroode
as code owners
|
WalkthroughThis pull request updates multiple Storybook configuration files and the project's task dependency settings. A placeholder comment is added in one Storybook config to indicate future Wagtail story composition. The sorting logic for Storybook stories has been removed from two preview configurations. Additionally, story titles have been updated in two file configurations to reflect new categorization schemes, and specific design system story paths have been removed in another Storybook config. Finally, the task dependency in turbo.json has been modified so that the "storybook" task now depends on the "build" task. Changes
Sequence Diagram(s)sequenceDiagram
participant Dev as Developer
participant Build as Build Task
participant SB as Storybook Task
Dev->>Build: Trigger build process
Build->>SB: Notify build completion
SB->>Dev: Launch Storybook with updated config
Suggested labels
Suggested reviewers
Poem
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
packages/components/modules/profiles/web/ProfileSettingsComponent/__storybook__/stories.tsxOops! Something went wrong! :( ESLint: 8.57.1 Error: Cannot read config file: /packages/components/.eslintrc.js
packages/components/.storybook/main.tsOops! Something went wrong! :( ESLint: 8.57.1 Error: Cannot read config file: /packages/components/.eslintrc.js
📜 Recent review detailsConfiguration used: CodeRabbit UI ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (7)
💤 Files with no reviewable changes (3)
🚧 Files skipped from review as they are similar to previous changes (4)
🪧 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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
packages/components/.storybook/main.ts (1)
27-27: Add TODO for Wagtail Stories Composition.
A placeholder comment has been added to indicate future composition of Wagtail stories. Once these stories are ready, please replace this TODO with the actual implementation to maintain clarity.packages/design-system/components/web/buttons/FileUploadButton/__storybook__/FileUploadButton.mdx (1)
3-3: Update Story Title for Consistent Categorization.
The title now uses a pipe (|) delimiter instead of a slash, aligning with the updated categorization scheme. Verify that this new title format is consistently applied across all design system stories.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
packages/components/__generated__/ActivityLogsFragment.graphql.tsis excluded by!**/__generated__/**
📒 Files selected for processing (7)
packages/components/.storybook/main.ts(1 hunks)packages/components/.storybook/preview.ts(0 hunks)packages/components/modules/profiles/web/ProfileSettingsComponent/__storybook__/stories.tsx(1 hunks)packages/design-system/.storybook/preview.ts(0 hunks)packages/design-system/components/web/buttons/FileUploadButton/__storybook__/FileUploadButton.mdx(1 hunks)packages/wagtail/.storybook/main.ts(0 hunks)turbo.json(1 hunks)
💤 Files with no reviewable changes (3)
- packages/design-system/.storybook/preview.ts
- packages/wagtail/.storybook/main.ts
- packages/components/.storybook/preview.ts
🔇 Additional comments (2)
turbo.json (1)
40-42: Adjust Storybook Task Dependency.
Changing the dependency to["^build"]ensures that the build task completes before Storybook runs, which supports the updated task flow. Please ensure that there are no unintended circular dependencies with other tasks.packages/components/modules/profiles/web/ProfileSettingsComponent/__storybook__/stories.tsx (1)
8-10: Revise Component Title for Updated Categorization.
The component title has been updated to use a pipe delimiter and a reorganized path (@baseapp-frontend | components/Profiles/ProfileSettingsComponent), which aligns with the new naming conventions. Ensure this format is used consistently across Storybook.
turbo.json
Outdated
| @@ -38,7 +38,7 @@ | |||
| "outputs": [] | |||
| }, | |||
| "storybook": { | |||
| "dependsOn": ["^storybook"] | |||
| "dependsOn": ["^build"] | |||
There was a problem hiding this comment.
lets also add
"cache": false,
"persistent": true
since it's similar to a dev mode
anicioalexandre
added
the
needs changes
deboracosilveira
force-pushed
the
storybook-adjustments
branch
from
40cd629 to
a731b66
Compare
|
Summary by CodeRabbit