rdkcentral / Lightning

Lightning - The WPE UI Framework for developing Apps and UX
Apache License 2.0
191 stars 109 forks source link

Is There A Hard Dependency On Using Rollup As A Build Tool #44

Open im-bob-loucans opened 5 years ago

im-bob-loucans commented 5 years ago

Ran across this comment inside of StateMachine.mjs:

static _getStateName(state) {
        const name = state.name;
        const index = name.indexOf('$');
        if (index > 0) {
            // Strip off rollup name suffix.
            return name.substr(0, index);
        }
        return name;
    }

Also does this prevent using minification tools that change method/class names? - if so can you provide documentation on some of these constraints around consuming library?

g-zachar commented 5 years ago

Hey @im-bob-loucans

Rollup is not enforced in any way, it was probably chosen as bundler from the options available at the moment. So far we have not experienced many problems with bundling our apps or Lightning itself but that may be because we are not using bundlers extensively.

I can't tell what the result of aggressive name mangling will be, but ES6 to ES5 transpilation and minification should at the very least work.

If there are any issues with Lightning when used in conjunction with e.g. Webpack, this is something we can look into.

im-bob-loucans commented 5 years ago

Thanks for reply.

I turned on minification using both rollup and webpack tools - in both cases the the app stopped working. I believe I tracked this down to changes class and function names. In particular I think the state machine requires the name of the state class and the names used in _setState methods to be the match. Also, there is specific string matching done to call the $enter and $exit methods. To correct I did this -

Rollup:

    plugins: [
        ...,
        terser.terser({
            keep_classnames: true,
            keep_fnames: true,
            sourcemap: false,
        }),
        ...,
    ],

Webpack:

...
    optimization: {
        minimize: true,
        minimizer: [
            new TerserPlugin({
                terserOptions: {
                    keep_classnames: true,
                    keep_fnames: true
                }
            })
        ]
    },
...

Perhaps you could add a documentation section on using use with bundlers and packaging.

MykhailoDz commented 4 years ago

@g-zachar is there any updates to provide documentation section on using with bundles and packaging? It would be great to get configs for webpack with transformation es6 to es5.

g-zachar commented 4 years ago

Hey @MykhailoDz

This matter is still to be addressed, we have several dependencies that prevent us from moving forward with this one and we need to tackle them first.

Best regards