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

Fix csf-plugin loader #21629

Merged
merged 1 commit into from
Mar 16, 2023
Merged

Fix csf-plugin loader #21629

merged 1 commit into from
Mar 16, 2023

Conversation

valentinpalkovic
Copy link
Contributor

@valentinpalkovic valentinpalkovic commented Mar 16, 2023

Closes #21387

What I did

The CSF-Plugin loader was not applying the necessary transformations in Angular projects.

How to test

  1. Run an Angular sandbox
  2. Open Storybook in your browser
  3. Access the addons-docs-docspage-basic--docs Story -> JSDocs should be visible

Bildschirm­foto 2023-03-16 um 12 51 31

Checklist

  • Make sure your changes are tested (stories and/or unit, integration, or end-to-end tests)
  • Make sure to add/update documentation regarding your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Maintainers

  • If this PR should be tested against many or all sandboxes,
    make sure to add the ci:merged or ci:daily GH label to it.
  • Make sure this PR contains one of the labels below.

["cleanup", "BREAKING CHANGE", "feature request", "bug", "documentation", "maintenance", "dependencies", "other"]

@valentinpalkovic valentinpalkovic self-assigned this Mar 16, 2023
@valentinpalkovic valentinpalkovic added the ci:daily Run the CI jobs that normally run in the daily job. label Mar 16, 2023
@valentinpalkovic valentinpalkovic force-pushed the valentin/fix-csf-plugin-for-angular branch 2 times, most recently from 9ca58a5 to 672a5e4 Compare March 16, 2023 12:56
The CSF-Plugin loader was not applying the necessary transformations in Angular projects.

Co-authored-by: Norbert de Langen <[email protected]>
@valentinpalkovic valentinpalkovic force-pushed the valentin/fix-csf-plugin-for-angular branch from 672a5e4 to 372a550 Compare March 16, 2023 13:40
@ndelangen ndelangen merged commit 66000bb into next Mar 16, 2023
@ndelangen ndelangen deleted the valentin/fix-csf-plugin-for-angular branch March 16, 2023 16:15
@shilman
Copy link
Member

shilman commented Mar 17, 2023

@valentinpalkovic @ndelangen did you test this change across various project types? When I wrote csf-plugin I originally wrote it as a transformer, but switched to a loader to make sure that the code it processes still contains comments. That wasn't the case at the time.

@valentinpalkovic
Copy link
Contributor Author

valentinpalkovic commented Mar 17, 2023

@shilman I have written an e2e test that guarantees its functionality across all sandboxes. Or do you have a community project in mind, where it was not working?

@shilman
Copy link
Member

shilman commented Mar 17, 2023

@valentinpalkovic I don't actually remember the problem case, just that it was common. Perhaps these lines fix it. Let's consider it solved and see if anything comes back from the community. Thanks for testing!!! 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug ci:daily Run the CI jobs that normally run in the daily job.
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
3 participants