Move custom options to "ember-cli-babel" options hash #105

Turbo87 · 2016-12-05T17:35:51Z

Resolves #102 and unblocks part of the journey to Babel 6

/cc @rwjblue @stefanpenner @nathanhammond

This will allow Ember CLI to detect what config key "compileModules" needs to be put into

nathanhammond · 2016-12-05T19:13:38Z

Tests? I think we can unit test the invocations to _getBabelOptions and shouldIncludePolyfill.
Are there other options we supported for ember-cli-babel under the babel namespace?

Turbo87 · 2016-12-05T19:16:50Z

Are there other options we supported for ember-cli-babel under the babel namespace?

since those are the only two options that ember-cli-babel cares about I don't think there are more

Tests? I think we can unit test the invocations to _getBabelOptions and shouldIncludePolyfill

do we have some sort of test harness for that?

Turbo87 · 2016-12-05T21:24:04Z

@nathanhammond got tests now for the new logic

nathanhammond · 2016-12-05T23:34:40Z

index.js

+    var customOptions = addonOptions['ember-cli-babel'];
+
+    if (customOptions && 'includePolyfill' in customOptions) {
+      return customOptions.includePolyfill === true;


Can we check to see if it is in both places here as well and writeDeprecateLine?

FYI - we can't rely on writeDeprecateLine as far back as this lib supports

@rwjblue And I was proud of knowing this because of recent spelunking: #105 (comment)

It turns out that having an in-built ecosystem mental model is absurdly valuable...

@rwjblue since the deprecation will only be triggered in recent CLIs we can just use writeDeprecateLine here

@nathanhammond I'll move the deprecation check in front of everything

Good point RE, newer CLI's only doing the deprecation. Maybe you can leave an inline comment (so future selves don't see it's use here as an excuse to use it for other ember-CLI deprecations)? I don't feel strongly either way though...

nathanhammond · 2016-12-05T23:37:55Z

index.js

-      } else {
-        ui.writeLine(message, 'ERROR');
+  _getAddonOptions: function() {
+    return (this.parent && this.parent.options) || (this.app && this.app.options) || {};


That second check shouldn't be required unless we're going way back in support. (Before 0.2.0.)

@nathanhammond that is pretty much the original code and not modified by me (see https://github.com/babel/ember-cli-babel/blob/b9a0dc232f4038bf6c95de51f71b04faff08406d/index.js#L76)

nathanhammond · 2016-12-05T23:40:23Z

index.js

+    var customOptions = addonOptions['ember-cli-babel'];
+
+    if (customOptions && 'compileModules' in customOptions) {
+      return customOptions.compileModules === true;


Same story: can we check to see if it is in both places here as well and writeDeprecateLine?

nathanhammond · 2016-12-05T23:41:45Z

index.js

-  }
+  _getBabelOptions: function() {
+    var addonOptions = this._getAddonOptions();
+    var options = clone(addonOptions.babel || {});


Can we name options a bit more clearly? I had to look at this multiple times to figure out what it was supposed to be.

options was the original name. I kept it to try to keep the diff smaller.

nathanhammond · 2016-12-05T23:42:53Z

index.js

-      options.blacklist.push('es6.modules');
+
+    if (compileModules) {
+      if (options.blacklist.indexOf('es6.modules') >= 0) {


Let's save this off, you use it three times.

again: this existed already before this PR (see https://github.com/babel/ember-cli-babel/blob/b9a0dc232f4038bf6c95de51f71b04faff08406d/index.js#L125-L135)

Yes, but you already modify those lines, so let's address this one.

nathanhammond · 2016-12-05T23:44:39Z

After these changes I'm pretty sure it's good to go. Would like a bonus confirmation from @rwjblue.

rwjblue · 2016-12-06T03:29:03Z

index.js

@@ -16,6 +17,7 @@ module.exports = {
    var dep = checker.for('ember-cli', 'npm');

    this._shouldSetupRegistryInIncluded = !dep.satisfies('>=0.2.0');
+    this._shouldShowBabelDeprecations = !dep.lt('2.11.0-beta.1');


I think this should be < 2.11.0-beta.2 since 2.11.0-beta.1 didn't include the code to prevent deprecations...?

@rwjblue I'm fine with either

rwjblue · 2016-12-06T03:29:09Z

Agreed, I am 👍 once the current round of requests are resolved. We should followup with updates in ember-cli's beta branch ASAP though...

Turbo87 · 2016-12-06T12:08:32Z

@rwjblue @nathanhammond addressed your requests

Prevent running babel twice. We currently transpile the output of all addon's `addon/` trees twice. Once inside the addon's `treeForAddon` step (this one excludes module transpilation by adding `es6.modules` to babel's blacklist) and the second time in [lib/broccoli/ember-app.js](https://github.com/ember-cli/ember-cli/blob/2df251ce018fd12570bdce72c167ff14a427fa74/lib/broccoli/ember-app.js#L929). This was originally done because we didn't require that addon's include their own preprocessors for JS (mostly due to performance reasons IIRC). In the time since that decision was made, we have swapped from a few different systems `es6-module-transpiler` -> `esperanto` -> `babel`. Now that our module transpilation step is using the same thing as we recommend addon's use (`ember-cli-babel`) what we are doing seems pretty whacky. This PR removes the double processing of addon's `addon/` files through babel, and includes a deprecation message for the scenario that originally prompted the second pass (where an addon didn't include a module transpiling preprocessor). TODO: - [x] Confirm that we have tests that already confirm this is working properly (I believe that our existing nested addon tests cover these changes, but I'd like to confirm). - [ ] Consider / discuss backporting the deprecation message for addons that do not have a transpiler and are relying on the global processing step. - [X] Add helpful error if an addon overrides `this.options.babel.compileModules` - [X] Implement logic to avoid deprecation being added in emberjs/ember-cli-babel#105. - [X] Split out `findAddonByName` into a utility method to be shared - [ ] r? Addresses parts of #5015

@Turbo87

Prevent deprecation from `ember-cli-babel` config options. Future versions of ember-cli-babel will be moving the location for its own configuration options out of `babel` and will be issuing a deprecation if used in the older way. This changes things around to detect the correct (undeprecated) options location, and use it when possible. Otherwise it falls back to `babel` (which is backwards compatible without a deprecation and forwards compatible with a deprecation). /cc @Turbo87 Reference: emberjs/ember-cli-babel#105

Turbo87 added 6 commits December 5, 2016 18:34

Return all "options" from getAddonOptions()

32b8115

Extract "compileModules" variable

bbf6375

Add "configKey" property

90e3a48

This will allow Ember CLI to detect what config key "compileModules" needs to be put into

Read custom properties from ember-cli-babel and babel options

a086fa8

Move getAddonOptions/getBabelOptions() functions into the "class"

d23a360

Print deprecation messages for custom properties in "babel" options hash

d332718

Turbo87 added the internal label Dec 5, 2016

Turbo87 added 2 commits December 5, 2016 22:13

Add unit tests for shouldIncludePolyfill() function

f3110af

Extract _shouldCompileModules() method incl. unit tests

df21fbb

nathanhammond suggested changes Dec 5, 2016

View reviewed changes

rwjblue reviewed Dec 6, 2016

View reviewed changes

rwjblue mentioned this pull request Dec 6, 2016

Prevent running babel twice. ember-cli/ember-cli#6530

Merged

6 tasks

Turbo87 added 2 commits December 6, 2016 13:05

Print deprecation message too if both settings are used

4c130df

Show custom option deprecations starting with Ember CLI v2.11.0-beta.2

21d46fe

Turbo87 added 2 commits December 6, 2016 14:09

Add code comment regarding the use of writeDeprecateLine()

90a8228

Extract "blacklistModulesIndex" variable

b231816

rwjblue mentioned this pull request Dec 7, 2016

Prevent deprecation from ember-cli-babel config options. ember-cli/ember-cli#6537

Merged

Turbo87 merged commit ae220d2 into emberjs:master Dec 7, 2016

Turbo87 deleted the custom-options branch December 7, 2016 18:39

bertdeblock mentioned this pull request Feb 3, 2023

Plan v5 Release ember-cli/ember-cli#10163

Closed

32 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move custom options to "ember-cli-babel" options hash #105

Move custom options to "ember-cli-babel" options hash #105

Turbo87 commented Dec 5, 2016

nathanhammond commented Dec 5, 2016

Turbo87 commented Dec 5, 2016

Turbo87 commented Dec 5, 2016

nathanhammond Dec 5, 2016

rwjblue Dec 6, 2016

nathanhammond Dec 6, 2016

Turbo87 Dec 6, 2016

rwjblue Dec 6, 2016

Turbo87 Dec 6, 2016

nathanhammond Dec 5, 2016

Turbo87 Dec 6, 2016

nathanhammond Dec 5, 2016

nathanhammond Dec 5, 2016

Turbo87 Dec 6, 2016

nathanhammond Dec 6, 2016

nathanhammond Dec 5, 2016

Turbo87 Dec 6, 2016

nathanhammond Dec 6, 2016

Turbo87 Dec 7, 2016

nathanhammond commented Dec 5, 2016

rwjblue Dec 6, 2016

Turbo87 Dec 6, 2016

rwjblue commented Dec 6, 2016

Turbo87 commented Dec 6, 2016

Move custom options to "ember-cli-babel" options hash #105

Move custom options to "ember-cli-babel" options hash #105

Conversation

Turbo87 commented Dec 5, 2016

nathanhammond commented Dec 5, 2016

Turbo87 commented Dec 5, 2016

Turbo87 commented Dec 5, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nathanhammond commented Dec 5, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rwjblue commented Dec 6, 2016

Turbo87 commented Dec 6, 2016