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

CLI: Add support for custom vite config to autoblocker #26087

Merged
merged 2 commits into from
Feb 20, 2024

Conversation

ndelangen
Copy link
Member

Closes: #25934 (review)

What I did

fix #25934 (review)

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make 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/core team 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>

@ndelangen ndelangen self-assigned this Feb 19, 2024
@ndelangen ndelangen marked this pull request as ready for review February 19, 2024 09:18
Comment on lines +50 to +54
mainConfig.core?.builder &&
typeof mainConfig.core?.builder !== 'string' &&
mainConfig.core?.builder.options
) {
isViteConfigFileFound = !!mainConfig.core?.builder.options.viteConfigPath;
Copy link
Contributor

Choose a reason for hiding this comment

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

couldn't this be simplified a little by just doing optional-chaining all the way down?

Suggested change
mainConfig.core?.builder &&
typeof mainConfig.core?.builder !== 'string' &&
mainConfig.core?.builder.options
) {
isViteConfigFileFound = !!mainConfig.core?.builder.options.viteConfigPath;
) {
isViteConfigFileFound = !!mainConfig.core?.builder?.options?.viteConfigPath;

Copy link
Contributor

Choose a reason for hiding this comment

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

Could be. Although I personally like the explicit style here a bit more because it makes clear, that builder can be a string or object.

@@ -45,7 +45,16 @@ export const viteConfigFile = {

const rendererName = frameworkToRenderer[frameworkName as keyof typeof frameworkToRenderer];

if (!viteConfigPath && isUsingViteBuilder) {
if (
!isViteConfigFileFound &&
Copy link
Contributor

Choose a reason for hiding this comment

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

There's a scenario here where the user specifies a custom path to a file that doesn't exist, which will return existed: true but there won't be a file.

This is probably an edge case, but I have seen support comments suggesting this as a way to disable auto-loading of the root Vite config entirely, so it's not completely unrealistic to get in this situation.

Copy link
Member Author

@ndelangen ndelangen Feb 19, 2024

Choose a reason for hiding this comment

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

I feel like it's not the blocker's responsibility to verify if the user configured this correctly; do you?

@ndelangen ndelangen merged commit 018f58a into next Feb 20, 2024
58 checks passed
@ndelangen ndelangen deleted the norbert/fix-viteconfig-configered-patch branch February 20, 2024 08:55
@github-actions github-actions bot mentioned this pull request Feb 20, 2024
26 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants