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

Angular: Fix CSF Plugin #25098

Merged

Conversation

valentinpalkovic
Copy link
Contributor

@valentinpalkovic valentinpalkovic commented Dec 4, 2023

Closes #21387, #17233, #24241, #20475, #14043

What I did

The CSF Plugin was reading the source file from the filesystem instead of processing it as a loader within a loader chain. The transformations applied by the CSF Plugin overrode any processing that had occurred before. Angular for instance does also access the filesystem directly to transform files. The CSF loader therefore has to be applied at a later point. This requires the CSF loader to apply the necessary transformations on already transformed files. The loader has to read the original source file, though, to get the source code before any other transformer touches it (prevent removed comments or transformed code).

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!

Test that JSON comments are preserved
  1. Go to one of the deployed Angular Storybooks in Chromatic
  2. Visit ?path=/docs/addons-docs-docspage-basic--docs story
  3. JSON docs are applied as descriptions to args
Storysource
  1. Create an Angular sandbox
  2. Install @storybook/storysource
  3. Visit a Story in the browser. The Storysource section in the controls tab should not show "Loading source...", but the actual source code of that Story instead.

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>

@valentinpalkovic valentinpalkovic self-assigned this Dec 4, 2023
@valentinpalkovic valentinpalkovic added ci:daily Run the CI jobs that normally run in the daily job. bug angular labels Dec 4, 2023
@valentinpalkovic valentinpalkovic force-pushed the valentin/fix-csf-loader-for-angular-second-attempt branch from 208ac2b to ca523d3 Compare December 4, 2023 07:47
@valentinpalkovic valentinpalkovic force-pushed the valentin/fix-csf-loader-for-angular-second-attempt branch from ca523d3 to cdb5079 Compare December 4, 2023 08:04
@valentinpalkovic valentinpalkovic marked this pull request as ready for review December 4, 2023 09:12
Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

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

❤️ ❤️ ❤️
This looks so much better!!!
❤️ ❤️ ❤️

@valentinpalkovic valentinpalkovic added ci:normal ci:daily Run the CI jobs that normally run in the daily job. patch:yes Bugfix & documentation PR that need to be picked to main branch and removed ci:daily Run the CI jobs that normally run in the daily job. ci:normal labels Dec 4, 2023
@valentinpalkovic valentinpalkovic merged commit 96bcc58 into next Dec 4, 2023
105 of 121 checks passed
@valentinpalkovic valentinpalkovic deleted the valentin/fix-csf-loader-for-angular-second-attempt branch December 4, 2023 20:39
storybook-bot pushed a commit that referenced this pull request Dec 4, 2023
…r-angular-second-attempt

Angular: Fix CSF Plugin
(cherry picked from commit 96bcc58)
storybook-bot pushed a commit that referenced this pull request Dec 5, 2023
…r-angular-second-attempt

Angular: Fix CSF Plugin
(cherry picked from commit 96bcc58)
storybook-bot pushed a commit that referenced this pull request Dec 5, 2023
…r-angular-second-attempt

Angular: Fix CSF Plugin
(cherry picked from commit 96bcc58)
storybook-bot pushed a commit that referenced this pull request Dec 5, 2023
…r-angular-second-attempt

Angular: Fix CSF Plugin
(cherry picked from commit 96bcc58)
storybook-bot pushed a commit that referenced this pull request Dec 5, 2023
…r-angular-second-attempt

Angular: Fix CSF Plugin
(cherry picked from commit 96bcc58)
storybook-bot pushed a commit that referenced this pull request Dec 5, 2023
…r-angular-second-attempt

Angular: Fix CSF Plugin
(cherry picked from commit 96bcc58)
storybook-bot pushed a commit that referenced this pull request Dec 5, 2023
…r-angular-second-attempt

Angular: Fix CSF Plugin
(cherry picked from commit 96bcc58)
storybook-bot pushed a commit that referenced this pull request Dec 6, 2023
…r-angular-second-attempt

Angular: Fix CSF Plugin
(cherry picked from commit 96bcc58)
storybook-bot pushed a commit that referenced this pull request Dec 6, 2023
…r-angular-second-attempt

Angular: Fix CSF Plugin
(cherry picked from commit 96bcc58)
storybook-bot pushed a commit that referenced this pull request Dec 6, 2023
…r-angular-second-attempt

Angular: Fix CSF Plugin
(cherry picked from commit 96bcc58)
storybook-bot pushed a commit that referenced this pull request Dec 6, 2023
…r-angular-second-attempt

Angular: Fix CSF Plugin
(cherry picked from commit 96bcc58)
storybook-bot pushed a commit that referenced this pull request Dec 6, 2023
…r-angular-second-attempt

Angular: Fix CSF Plugin
(cherry picked from commit 96bcc58)
@github-actions github-actions bot mentioned this pull request Dec 7, 2023
44 tasks
storybook-bot pushed a commit that referenced this pull request Dec 7, 2023
…r-angular-second-attempt

Angular: Fix CSF Plugin
(cherry picked from commit 96bcc58)
storybook-bot pushed a commit that referenced this pull request Dec 7, 2023
…r-angular-second-attempt

Angular: Fix CSF Plugin
(cherry picked from commit 96bcc58)
storybook-bot pushed a commit that referenced this pull request Dec 7, 2023
…r-angular-second-attempt

Angular: Fix CSF Plugin
(cherry picked from commit 96bcc58)
storybook-bot pushed a commit that referenced this pull request Dec 7, 2023
…r-angular-second-attempt

Angular: Fix CSF Plugin
(cherry picked from commit 96bcc58)
@github-actions github-actions bot added patch:done Patch/release PRs already cherry-picked to main/release branch labels Dec 7, 2023
@kasperpeulen kasperpeulen restored the valentin/fix-csf-loader-for-angular-second-attempt branch January 11, 2024 15:30
@ndelangen ndelangen mentioned this pull request Jan 23, 2024
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
angular bug ci:daily Run the CI jobs that normally run in the daily job. patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Descriptions from JSDocs not rendered for Angular stories in 7.0.0-beta.60
2 participants