Skip to content

Angular: remove invalid defaults for start-storybook #31337

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

Merged

Conversation

AgentEnder
Copy link
Contributor

@AgentEnder AgentEnder commented May 1, 2025

What I did

This PR removes some invalid defaults from the builder schemas for angular CLI builders. This is important because in the future Nx will warn about them, and as-is they are not applied.

Specifically, there are default values of "" (an empty string) for values which should be an object. For now, Nx is skipping the application of this default. In the future, Nx will warn if it detects this.

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 (covered by the tests for angular integration)

Manual testing

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

  1. Created a sandbox repo via Nx's E2E tests
  2. Applied schema.json changes in node_modules
  3. Observed that the issue was fixed and expected codepaths are hit.

Documentation

No applicable docs

  • 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-storybook/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>

Greptile Summary

Removed invalid default values from Angular CLI builder schemas to ensure proper type validation and prevent future Nx warnings.

  • Removed empty string default for styles array in both builder schemas
  • Removed empty string default for stylePreprocessorOptions object in both builder schemas
  • Removed null default for browserTarget in code/frameworks/angular/src/builders/start-storybook/schema.json
  • Changes ensure proper type validation for array and object properties in Angular CLI builders

💡 (1/5) You can manually trigger the bot by mentioning @greptileai in a comment!

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

2 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings | Greptile

Comment on lines 104 to 107
"items": {
"$ref": "#/definitions/styleElement"
},
"default": ""
}
},
Copy link
Contributor

Choose a reason for hiding this comment

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

style: Consider adding a default empty array [] for styles since it's an array type

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

LGTM

1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile

@valentinpalkovic valentinpalkovic changed the title fix(angular): remove invalid defaults for start-storybook Angular: remove invalid defaults for start-storybook May 2, 2025
@valentinpalkovic valentinpalkovic self-assigned this May 2, 2025
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

2 file(s) reviewed, 2 comment(s)
Edit PR Review Bot Settings | Greptile

Comment on lines 104 to +106
"items": {
"$ref": "#/definitions/styleElement"
},
"default": ""
}
Copy link
Contributor

Choose a reason for hiding this comment

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

style: Remove trailing whitespace after closing brace

Comment on lines +120 to 121
"additionalProperties": false
},
Copy link
Contributor

Choose a reason for hiding this comment

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

style: Remove trailing whitespace after closing brace

@valentinpalkovic valentinpalkovic merged commit 807c4a8 into storybookjs:next May 2, 2025
56 of 57 checks passed
@AgentEnder
Copy link
Contributor Author

AgentEnder commented May 2, 2025

@valentinpalkovic thanks for the quick merge 🎉

@github-actions github-actions bot mentioned this pull request May 2, 2025
9 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.

2 participants