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

chore: remove legacy dist files (BREAKING CHANGE) #3585

Merged
merged 2 commits into from
Jun 27, 2023
Merged

Conversation

nolanlawson
Copy link
Collaborator

Details

Fixes #3445. Removes legacy dist/ files from the npm package.

Does this pull request introduce a breaking change?

  • 🚨 Yes, it does introduce a breaking change.

The following will no longer work:

require('@lwc/compiler/dist/commonjs/transformers/transformer.js')
require('@lwc/engine-dom/dist/engine-dom.js')
require('@lwc/synthetic-shadow/dist/synthetic-shadow.js')

Instead of a deep require(), do this:

require('@lwc/compiler')
require('@lwc/engine-dom')
require('@lwc/synthetic-shadow')

Does this pull request introduce an observable change?

  • ⚠️ Yes, it does include an observable change.

@nolanlawson nolanlawson added this to the 3.0.0 milestone Jun 19, 2023
@nolanlawson nolanlawson requested a review from a team as a code owner June 19, 2023 20:33
@nolanlawson

This comment was marked as outdated.

@nolanlawson

This comment was marked as outdated.

1 similar comment
@nolanlawson

This comment was marked as outdated.

@divmain
Copy link
Contributor

divmain commented Jun 26, 2023

I believe there are consumers that still use this pattern: require('@lwc/compiler/dist/commonjs/transformers/transformer.js'). Is this a just nice-to-have for 3.0.0? If so, I'd push for holding off on this change, as I believe it will be disruptive.

Nolan and I chatted about this, and he rightly pointed out that the blast radius is significantly lessened for folks that control their NPM dependencies directly. Because of that, I withdraw my opposition.

@nolanlawson nolanlawson merged commit 92f63e4 into master Jun 27, 2023
2 checks passed
@nolanlawson nolanlawson deleted the nolan/issue-3445 branch June 27, 2023 18:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Expose consistent dist files across packages
2 participants