EngineAddon -- unusual options config

dfreeman / ember-cli-node-assets

Include stylesheets, images and other assets in your Ember app from node modules

MIT License

62 stars 6 forks source link

EngineAddon -- unusual options config #11

Open XaserAcheron opened 7 years ago

XaserAcheron commented 7 years ago

Something @dfreeman and I discovered on Slack that I'm noting down for reference: ember-engines's EngineAddon class does some funky stuff that makes the documented way of defining options.nodeAssets not work.

A relevant quote:

dfreeman [2:05 PM] so if you have module.exports = { foo: 'bar' }; in an addon, the addon instance itself will have addon.foo === 'bar' but if you have module.exports = EngineAddon.extend({ foo: 'bar' });, the addon instance will have addon.options.foo === 'bar' so it ends up with double options

Effectively, the config is saved to module.exports.options.options.nodeAssets, which just don't work. ;)

Side-observation from the discussion: ember-cli-babel does its configuration in much the same way, so is it affected as well? Or does it skirt this somehow?

An extra thought: Should this be something we bring up to the ember-engines devs if we aren't the only ones affected? It may make more sense to treat it as a regression.

XaserAcheron commented 7 years ago

For anyone in the same boat: @dfreeman suggested a temporary workaround (which works great, BTW): take nodeAssets out of the options object for now.

Before:

const EngineAddon = require('ember-engines/lib/engine-addon');
module.exports = EngineAddon.extend({
    name: 'this-is-an-engine',
    options: {
        nodeAssets: {
            // ...
        }
    }
});

After:

const EngineAddon = require('ember-engines/lib/engine-addon');
module.exports = EngineAddon.extend({
    name: 'this-is-an-engine',
    nodeAssets: {
        // ...
    }
});

Just be prepared to change your code again once a fix has been made.