Conversation
…to true Co-authored-by: JReinhold <5678122+JReinhold@users.noreply.github.com>
experimentalComponentsManifest → componentsManifest, default to true
📝 WalkthroughWalkthroughRenamed Storybook config flag Changes
Sequence Diagram(s)sequenceDiagram
participant DevServer as DevServer
participant Build as BuildStatic
participant Manifests as ManifestWriter
participant Telemetry as Telemetry
DevServer->>DevServer: start
alt features.componentsManifest !== false
DevServer->>Manifests: registerManifests()
Manifests-->>DevServer: registration complete
end
DevServer->>Telemetry: doTelemetry()
Build->>Build: run static build
alt features.componentsManifest !== false
Build->>Manifests: writeManifests()
Manifests-->>Build: manifests written
end
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
✨ Finishing Touches
Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
code/core/src/types/modules/core-common.ts (1)
504-504: Consider adding JSDoc documentation for thecomponentsManifestfeature flag.Other feature flags in this interface include JSDoc comments describing their purpose and default values (e.g.,
viewport,highlight,experimentalCodeExamples). Since this flag is graduating from experimental status, adding documentation would improve discoverability and help users understand when/why to opt out.+ /** + * Enable generation of the components manifest file containing component metadata. + * + * `@default` true + */ componentsManifest?: boolean;🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@code/core/src/types/modules/core-common.ts` at line 504, Add a JSDoc comment for the componentsManifest feature flag above the componentsManifest?: boolean; declaration in the core-common.ts interface: briefly describe what enabling/disabling the components manifest does, note that it has graduated from experimental, and document the default behavior/value and any compatibility/opt-out implications so users can discover and understand when to enable or disable it.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@code/core/src/types/modules/core-common.ts`:
- Line 504: Add a JSDoc comment for the componentsManifest feature flag above
the componentsManifest?: boolean; declaration in the core-common.ts interface:
briefly describe what enabling/disabling the components manifest does, note that
it has graduated from experimental, and document the default behavior/value and
any compatibility/opt-out implications so users can discover and understand when
to enable or disable it.
ℹ️ Review info
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
code/.storybook/main.tscode/core/src/core-server/build-static.tscode/core/src/core-server/dev-server.tscode/core/src/types/modules/core-common.tscode/lib/cli-storybook/src/sandbox-templates.ts
💤 Files with no reviewable changes (2)
- code/lib/cli-storybook/src/sandbox-templates.ts
- code/.storybook/main.ts
experimentalComponentsManifest → componentsManifest, default to trueexperimentalComponentsManifest → componentsManifest, default to true
|
View your CI Pipeline Execution ↗ for commit 75082e9
☁️ Nx Cloud last updated this comment at |
There was a problem hiding this comment.
@JReinhold The PR description is not following the PR template
|
FYI, I documented this as part of the "AI" docs PR, here: You can see a preview: https://deploy-preview-381--storybook-frontpage.netlify.app/docs/10.3/api/main-config/main-config-features |
Closes #
What I did
Graduates
experimentalComponentsManifestout of experimental status. The flag is renamed tocomponentsManifestand now defaults totrue— no backwards compatibility for the old name.Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
react-vitesandbox/manifests/components.jsonin its outputmain.ts:{ features: { componentsManifest: false }Caution
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/src/sandbox-templates.tsMake sure this PR contains one of the labels below:
Available labels
bug: Internal changes that fixes incorrect behavior.maintenance: User-facing maintenance tasks.dependencies: Upgrading (sometimes downgrading) dependencies.build: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup: Minor cleanup style change. Will not show up in release changelog.documentation: Documentation only changes. Will not show up in release changelog.feature request: Introducing a new feature.BREAKING CHANGE: Changes that break compatibility in some way with current major version.other: Changes that don't fit in the above categories.🦋 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/coreteam here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook publish.yml --field pr=<PR_NUMBER>Original prompt
Summary by CodeRabbit
Configuration Changes
Improvements