Skip to content

Account for ConfigItem being generated by another copy of Babel#11734

Merged
nicolo-ribaudo merged 8 commits intobabel:mainfrom
developit:patch-2
Nov 10, 2020
Merged

Account for ConfigItem being generated by another copy of Babel#11734
nicolo-ribaudo merged 8 commits intobabel:mainfrom
developit:patch-2

Conversation

@developit
Copy link
Copy Markdown
Member

@developit developit commented Jun 19, 2020 •
edited by gitpod-io bot
Loading

Q                       A
Fixed Issues? developit/microbundle#657
Patch: Bug Fix? yes
Major: Breaking Change?
Minor: New Feature?
Tests Added + Pass?
Documentation PR Link N/A
Any Dependency Changes? no
License MIT

This fixes ConfigItem unboxing when core.createConfigItem() is used to generate a ConfigItem that is then passed to a different copy of Babel. This is common in cases where npm fails to dedupe modules, or when differing versions of Babel are in-use.

// good - uses the version of babel that is doing the transforming:
module.exports = function preset(api) {
  api.createConfigItem(...)
}
// bad - uses whatever version this module installed:
import api from '@babel/core';
module.exports = babelLoader.custom({
  options() {
    api.createConfigItem(..)
  }
});

@babel-bot
Copy link
Copy Markdown
Collaborator

babel-bot commented Jun 19, 2020 •
edited
Loading

Build successful! You can test your changes in the REPL here: https://babeljs.io/repl/build/32245/

hzoo
hzoo approved these changes Jun 19, 2020
View reviewed changes
Copy link
Copy Markdown
Member

@hzoo hzoo left a comment

Choose a reason for hiding this comment

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

not sure how else we want to handle this issue, also wonder other cases we are using instanceof and might have this problem?

@codesandbox-ci
Copy link
Copy Markdown

codesandbox-ci bot commented Jun 19, 2020 •
edited
Loading

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit a00bf9e:

Sandbox Source
babel-repl-custom-plugin Configuration
babel-plugin-multi-config Configuration

@developit
Copy link
Copy Markdown
Member Author

developit commented Jun 19, 2020

Another suggestion, rather than changing all the instanceof checks, might be to throw or warn when this behavior is detected:

import core from '@babel/core';  // could be a separate copy of Babel (determined by npm)

export function custom() {
  return {
    config() {
      core.createConfigItem(...)
      // "Error: detected ConfigItem instances from a different version of Babel"
    }
  }
}

nicolo-ribaudo
nicolo-ribaudo reviewed Jun 20, 2020
View reviewed changes
JLHwung
JLHwung reviewed Jun 23, 2020
View reviewed changes
nicolo-ribaudo
nicolo-ribaudo reviewed Nov 9, 2020
View reviewed changes
@nicolo-ribaudo nicolo-ribaudo added the PR: Internal 🏠 A type of pull request used for our changelog categories label Nov 9, 2020
@nicolo-ribaudo nicolo-ribaudo merged commit ddd868f into babel:main Nov 10, 2020
@github-actions github-actions bot added the outdated A closed issue/PR that is archived due to age. Recommended to make a new issue label Feb 10, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 10, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@JLHwung JLHwung JLHwung left review comments

@existentialism existentialism existentialism approved these changes

@hzoo hzoo hzoo approved these changes

@nicolo-ribaudo nicolo-ribaudo nicolo-ribaudo approved these changes

Assignees

No one assigned

Labels

outdated A closed issue/PR that is archived due to age. Recommended to make a new issue pkg: core PR: Internal 🏠 A type of pull request used for our changelog categories

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@developit @babel-bot @existentialism @hzoo @JLHwung @nicolo-ribaudo