Core: Add defineConfig helper for main.js #30250
Conversation
|
View your CI Pipeline Execution ↗ for commit b181f27.
☁️ Nx Cloud last updated this comment at |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
21 file(s) reviewed, 13 comment(s)
Edit PR Review Bot Settings | Greptile
code/frameworks/angular/src/types.ts
Outdated
| export function defineConfig(config: StorybookConfig) { | ||
| return commonDefineConfig<StorybookConfig>(config); | ||
| } |
There was a problem hiding this comment.
style: consider adding JSDoc documentation for the defineConfig function to explain its purpose and usage
code/frameworks/ember/src/types.ts
Outdated
| export function defineConfig(config: StorybookConfig) { | ||
| return commonDefineConfig<StorybookConfig>(config); | ||
| } |
There was a problem hiding this comment.
style: defineConfig function should be explicitly typed with return type for better type safety
| @@ -1,3 +1,4 @@ | |||
| import { defineConfig as commonDefineConfig } from 'storybook/internal/common'; | |||
There was a problem hiding this comment.
logic: ensure this import path is correct - should it be '@storybook/internal/common' instead of 'storybook/internal/common'?
| export function defineConfig(config: StorybookConfig) { | ||
| return commonDefineConfig<StorybookConfig>(config); | ||
| } |
There was a problem hiding this comment.
style: consider adding JSDoc comment explaining the purpose of this helper function
| @@ -1,3 +1,4 @@ | |||
| import { defineConfig as commonDefineConfig } from 'storybook/internal/common'; | |||
There was a problem hiding this comment.
syntax: import path 'storybook/internal/common' may need to be '@storybook/internal/common' to match package naming conventions
| @@ -1,3 +1,4 @@ | |||
| import { defineConfig as commonDefineConfig } from 'storybook/internal/common'; | |||
There was a problem hiding this comment.
logic: ensure this import path is correct - should it be '@storybook/internal/common' instead of 'storybook/internal/common'?
| export function defineConfig(config: StorybookConfig) { | ||
| return commonDefineConfig<StorybookConfig>(config); | ||
| } |
There was a problem hiding this comment.
style: consider adding JSDoc comment explaining the purpose of this helper function
| export function defineConfig(config: StorybookConfig) { | ||
| return commonDefineConfig<StorybookConfig>(config); | ||
| } |
There was a problem hiding this comment.
style: consider adding JSDoc documentation for the defineConfig function to explain its purpose and usage
| @@ -1,3 +1,4 @@ | |||
| import { defineConfig as commonDefineConfig } from 'storybook/internal/common'; | |||
There was a problem hiding this comment.
syntax: import path 'storybook/internal/common' may need to be '@storybook/internal/common' to match standard package import format
| @@ -43,3 +44,7 @@ export type StorybookConfig = Omit< | |||
| > & | |||
| StorybookConfigWebpack & | |||
| StorybookConfigFramework; | |||
|
|
|||
| export function defineConfig(config: StorybookConfig) { | |||
| return commonDefineConfig<StorybookConfig>(config); | |||
There was a problem hiding this comment.
style: consider adding JSDoc comment explaining the purpose and usage of defineConfig
yannbf
changed the base branch from
kasper/csf-factories
to
yann/csf-factories-base
yannbf
changed the title
yannbf
force-pushed
the
yann/csf-factories-extra
branch
from
e280ec0 to
b181f27
Compare
Closes #30243
What I did
This PR introduces a defineConfig type helper for storybook main configs, a base config in core common and extended ones from each framework
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
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 canary-release-pr.yml --field pr=<PR_NUMBER>Greptile Summary
Adds a new
defineConfighelper function to enhance type inference for Storybook configurations across all frameworks.code/core/src/common/defineConfig.tswith type-safe configuration helperdefineConfigincode/core/src/common/index.tsdefineConfigwrappers in all frameworktypes.tsfilesmain.tsconfiguration files without breaking changes