Multiple static directories definable per-plugin

[julian]

As described here, edge versions of NodeBB support the definition of multiple static directories in a plugin. This may cause some breaking changes in future versions of NodeBB (e.g. v0.5+), but for now, they are backwards compatible.

Prior to this, static directories were defined in a plugin's plugin.json with this option:

{
    "staticDir": "assets"
}

They can now be defined thusly:

{
    "staticDirs": {
        "asdf": "first/dir",
        "qwerty": "second/dir"
    }
}

If you migrate to using staticDirs (note the "s" ) from staticDir, you'll have to update your CSS option as well, so that they are prefixed with a previously defined static directory, e.g.:

{
    "css": [
        "qwerty/test.css",
        "asdf/style.css"
    ]
}

[julian]

I've upgraded plugin-emoji to reflect these changes, you can see how it been migrated here in this diff

[Schamper]

Just to clarify, staticDir will still work just fine?

[julian]

@Mr_Waffle Yes, the change is backwards compatible, although it will throw a deprecation warning and you're encouraged to migrate to use staticDirs at some point

[Schamper]

@julian said:

at some point

When v0.3.1 is released so the masses are compatible

[julian]

Hahah, no rush. I'm not planning on removing support for staticDir until v0.5, so let the good times roll.

[bentael]

cool .

[Schamper]

Bumping. Just curious how exactly this works. For example, having:

	"staticDirs": {
		"poll": "static"
	},
	"css": [
		"poll/css/style.css"
	]

Will result in the css being loaded from /plugins/poll/css/style.css, which seems odd to me. How does it handle collisions?

Actually I just figured it out. The staticDir you define will create the /plugin/*dir* path... Question about collisions remains though, it's possible that plugin developers choose the same dir name.

[julian]

@Mr_Waffle NodeBB will refuse to map to the same directory more than once. It'll throw a warning and not bother loading the second static directory.

[frissdiegurke]

@julian Ya, but @mr_waffle is right: without an plugin-identifier within the path you cannot ensure that all plugins are compatible with each other...

I'd prefer the same behavior like the old staticDir did for each of the staticDirs-entries, so I don't have to ensure that I use plugin-independent unique path-names.

I don't see any negatives about the longer path-names

[julian]

Okay, no problem. Might even simplify the code a bit to do it this way.