-
Notifications
You must be signed in to change notification settings - Fork 785
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
feat(dist-custom-elements-bundle): add deprecation warning #3167
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left a few comments/suggestions, LMK what you think.
@splitinfinities PTAL and verify this meets your acceptance criteria surrounding running (namely with our Compiler/CLI APIs)
Checked this branch out, linked it to a component library and both within I have no AC for this warning to surface into a Browser's Console during the lifecycle of a watch command. I have no AC for this warning to fire off during an invoked command via Stencil's Core Compiler API. So yeah, this looks great to me! |
Co-authored-by: Ryan Waskiewicz <ryanwaskiewicz@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for review; made appropriate changes.
This fix has been included in the v2.12.0 release. |
Pull request checklist
Please check if your PR fulfills the following requirements:
npm run build
) was run locally and any changes were pushednpm test
) were run locally and passednpm run test.karma.prod
) were run locally and passednpm run prettier
) was run locally and passedPull request type
Please check the type of change your PR introduces:
What is the current behavior?
dist-custom-elements-bundle
is being deprecated in an upcoming major release of Stencil. See discussion in the following GitHub issue. Currently, no warning is shown to the user communicating this.GitHub Issue Number: #3136
What is the new behavior?
If
dist-custom-elements-bundle
is found in a Stencil config, a warning is fired when the build process begins that states:dist-custom-elements-bundle is deprecated and will be removed in a future version. Use "dist-custom-elements" instead. If "dist-custom-elements" does not meet your needs, please add a comment to https://github.com/ionic-team/stencil/issues/3136.
Does this introduce a breaking change?
Testing
A npm package tarball was generated from this branch (npm ci && npm run build && npm pack). It was then installed in a fresh Stencil project (
npx init stencil
). Said project was built both with and withoutdist-custom-elements-bundle
being present in the output targets config to verify that the warning only appeared when the output target is present.Other information