Set per-plugin registration options when registering an array of plugins

[martinheidegger]

When I want to set the options and a path prefix for a plugin it looks like this:

server.pack.register({
    plugin: require("my-plugin"),
    options: {
       foo: "bar"
    }
}, {
    route: {
        prefix: "/myprefix"
    }
}, function () {
    ... 
});

It looks like the object containing the route definition seems unnecessary clutter. Would it be possible to offer setting the route in the plugin definition? Somehow like:

server.pack.register({
    plugin: require("my-plugin"),
    options: {
       foo: "bar"
    },
    route: {
        prefix: "/myprefix"
    }
}, function () {
    ... 
});

[hueniverse]

I like to keep them separate because they are different options. One for the plugin and one for registration. I worry people will get confused about where to put the registration options (e.g. inside the plugin options which we cannot validate).

[martinheidegger]

It is a nuisance when registering one plugin but this makes it hard to register multiple plugins without having all of them prefixed.

For example:

server.pack.register([require("plugin-a"), require("plugin-b")], function () { ... });

Right now if I want to change the path for plugin-a I would have to write

var async = require("async");
async.serial([function (callback) {
    server.pack.register(require("plugin-a"), {
       route: {
            prefix: "/myprefix"
       }
    }, callback);
}, function (callback) {
   server.pack.register(require("plugin-b"), callback);
}], function () { ... });

compared to the proposal

server.pack.register([{
   plugin: require("plugin-a"),
   route: {
       prefix: "/myprefix"
   }
}, require("plugin-b")], function () { ... });

[mwawrusch]

@martin +1 for the nuisance factor.

On Mon, Aug 11, 2014 at 10:44 AM, Martin Heidegger <notifications@github.com

wrote:

It is a nuisance when registering one plugin but this makes it hard to
register multiple plugins without having all of them prefixed.

For example:

server.pack.register([require("plugin-a"), require("plugin-b")], function () { ... });

Right now if I want to change the path for plugin-a I would have to write

var async = require("async");async.serial([function (callback) {
server.pack.register(require("plugin-a"), {
route: {
prefix: "/myprefix"
}
}, callback);}, function (callback) {
server.pack.register(require("plugin-b"), callback);}], function () { ... });

compared to the proposal

server.pack.register([{
plugin: require("plugin-a"),
route: {
prefix: "/myprefix"
}}, require("plugin-b")], function () { ... });

—
Reply to this email directly or view it on GitHub
#1850 (comment).

Martin Wawrusch
p: +1 310 404 1698

modeista.com - Connect With Style
fanignite.com - ALPHA - Create Your Mobile App In 30 Seconds
wawrusch.com - Personal Blog
codedoctor.co - Professional Blog

Follow me on twitter at @MartinWawrusch http://twitter.com/MartinWawrusch

[hueniverse]

After much consideration, I much rather this kind of API innovation happen elsewhere first. It should be pretty easy to create utilities that will provide this, and we already have some of this today with the composer() API. We have a new module called glue just for that, and I think this work belongs there. You can easily add helpers there that will give you this functionality.

If later, we see that most people use glue helpers over direct access to register(), we can revisit.

[hueniverse]

Also requested in #2483 #2478 #2669

[lock]

This thread has been automatically locked due to inactivity. Please open a new issue for related bugs or questions following the new issue template instructions.