babel-plugin-transform-decorators-legacy icon indicating copy to clipboard operation
babel-plugin-transform-decorators-legacy copied to clipboard

Class properties work differently with transform-decorators-legacy

Open mattinsler opened this issue 9 years ago • 21 comments

Turning on transform-decorators-legacy will cause errors if you use class properties in a specific way.

class Foo {
  static SECOND = 1000;
  static MINUTE = Foo.SECOND * 60;
}

This will say that Foo is undefined while trying to evaluate Foo.SECOND. Without the decorators-legacy plugin this works.

mattinsler avatar Feb 03 '16 02:02 mattinsler

@jeffmo Would you expect the above code sample to work, or is this actually my plugin doing this properly and Babel 6 doing it wrong?

https://github.com/jeffmo/es-class-fields-and-static-properties defines properties as being evaluated before classScopeEnvRec.InitializeBinding(className, F) on step 26.i so it seems like the Foo binding in this code sample would still be uninitialized when Foo.SECOND was accessed, leading to a TDZ error in a real environment and an undefined value in this case.

loganfsmyth avatar Feb 07 '16 07:02 loganfsmyth

@mattinsler If you're manually specifying your plugins, the order sometimes matter. Make sure transform-decorators-legacy comes before transform-class-properties.

WRONG!!

"plugins": [
  "transform-class-properties",
  "transform-decorators-legacy"
]

RIGHT

"plugins": [
  "transform-decorators-legacy",
  "transform-class-properties"
]

jayphelps avatar May 31 '16 02:05 jayphelps

You'll Fix a BUG or I fixed a it for you?

uMaxmaxmaximus avatar Jun 23 '16 06:06 uMaxmaxmaximus

@uMaxmaxmaximus did you make sure the order of your plugins is correct, that transform-decorators-legacy comes before transform-class-properties? https://github.com/loganfsmyth/babel-plugin-transform-decorators-legacy/issues/17#issuecomment-222581635

jayphelps avatar Jun 23 '16 06:06 jayphelps

yes, babel cmd --plugins transform-decorators-legacy,transform-class-properties

image

image

Generated code

"use strict";

var _class, _temp;

function _classCallCheck(instance, Constructor) {
    if (!(instance instanceof Constructor)) {
        throw new TypeError("Cannot call a class as a function");
    }
}

var User = (_temp = _class = function User() {
    _classCallCheck(this, User);
}, _class.dd = {
    lol: User
}, _temp);


console.log(User.dd.lol);

//# sourceMappingURL=user.js.map

do like this:


var User = (function () {

    function User() {
        // constructor code
    }

    // static decorator magic
    _addDecorator(User, 'dd', decoratorOptions, /* original value */ {
        lol: User // in scope
    })

    // instance decorator magic
    _addDecorator(User.prototype, 'func', decoratorOptions, /* original value */ function(){

    })

})

uMaxmaxmaximus avatar Jun 23 '16 06:06 uMaxmaxmaximus

As I mentioned above, this is currently the specced behavior for this because User has not finished being defined yet when you are attempting to access it. In a real ES6 environment, you'd be getting a temporal deadzone error, but in Babel-transpiled code, you get undefined.

I agree that it's potentially confusing, but if you want this changed, that should be discussed in the specification repo here: https://github.com/jeffmo/es-class-fields-and-static-properties I have absolutely no control over this. @jeffmo may be able to clarify, but from that repo, it actually seems like Babel 6 sans-decorators is actually what is incorrect here, not this plugin.

loganfsmyth avatar Jun 23 '16 06:06 loganfsmyth

I filed a bug to get clarification: https://github.com/jeffmo/es-class-fields-and-static-properties/issues/40

loganfsmyth avatar Jun 23 '16 06:06 loganfsmyth

It seems to me improper specification and should not follow it. And I think that in this way many believe. but where to go. I have to write a decorator such as:

@schema({
 foo: User
})
class User {}

but this not works

works just ugly way

class User {}
User.schema = {lol: User}

But what if I want to create a class in expression?

return (function(){
  class User {}
  User.schema = {lol: User}
  return User
})()

It is obvious that this is a bug, and the specification is not true

uMaxmaxmaximus avatar Jun 23 '16 07:06 uMaxmaxmaximus

The class properties spec states (Step 24.ii.a) that the initializer scope inherits from the class-body scope; And the ES6 spec states (Step 4) that the class body scope does have access to the class binding (no TDZ). So indeed, the code above should work as expected.

I am planning to write out proper spec text for the next TC39 meeting at the end of July, so hopefully this will reduce confusion around some of these things.

jeffmo avatar Jun 23 '16 12:06 jeffmo

Okay! Given the results in https://github.com/jeffmo/es-class-fields-and-static-properties/issues/40, I'll change this to work better. I won't be able to get to it right away though.

loganfsmyth avatar Jun 23 '16 16:06 loganfsmyth

@loganfsmyth I won't be able to get to it right away though.

Need some help from Russian guys)?

uMaxmaxmaximus avatar Jul 15 '16 17:07 uMaxmaxmaximus

Any word on this getting resolved? It looks like babel 7 will be using this plugin by default. Would be nice for this behaviour to be fixed.

paul-sachs avatar Apr 19 '17 19:04 paul-sachs

Static properties seem to be working fine (had an additional glance at the output) when the order of plugins is correct. Is this still an issue or can we safely use this plugin if we're using static class properties?

langri-sha avatar Aug 13 '17 12:08 langri-sha

the example given seems fixed in my code, but if you try to reference your decorated class after it's declaration, you get an error:

function deco () {}

export default @deco class Foo {}

console.log(Foo); // <-- error Foo is not defined!

jsg2021 avatar Aug 13 '17 18:08 jsg2021

if you don't export and define at the same line, it's fine :/

jsg2021 avatar Aug 13 '17 18:08 jsg2021

I think this is still a problem even when the order of plugins is correct, at least in some configurations. I don't have a testcase I can share yet, but if I find out the cause/solution I'll follow up here.

mcav avatar Nov 20 '17 18:11 mcav

Just so it's known: I had an application that was ejected from create-react-app and it appears that babel-jest's createTransformer loaded things in the opposite order for some reason. I had to do the following:

const babelJest = require('babel-jest');

module.exports = babelJest.createTransformer({
  plugins: [
    'transform-class-properties',
    'transform-decorators-legacy',
    require.resolve('babel-plugin-inline-react-svg')
  ],
  presets: [require.resolve('babel-preset-react-app')],
  babelrc: false
});

Also, I had to do the backwards ordering in my package.json for some reason.

louisscruz avatar Nov 20 '17 21:11 louisscruz

(Actually I misspoke. Removing flow-strip-types fixed an unrelated issue, but not this one.)

mcav avatar Nov 21 '17 18:11 mcav

I'm also having issues with this when the plugins are in the correct order. My .babelrc looks like this:

{
  "presets": ["es2015", "react", "stage-3"],
  "plugins": ["transform-decorators-legacy", "transform-class-properties", "transform-flow-strip-types"]
}

madCode avatar Sep 17 '18 19:09 madCode

is there any solution?

javadbat avatar Sep 18 '18 11:09 javadbat

@javadbat upgrading jest to jest 23 and then setting up babel 7 resolved this specific issue. (Though I'm dealing with others right now, haha)

madCode avatar Sep 18 '18 20:09 madCode