pluginus

Install

npm install @asd14/pluginus

Use

exports default {
 /**
 * Which plugins need loading before this one
 *
 * @type {string[]}
 */
 depend: [],
 /**
 * Name other plugins can use to reference and use this plugin
 *
 * @type {string}
 */
 name: "PluginOne",
 /**
 * Factory function, only runs once when ititialized. The value this function
 * returns or resolves to will be passed to other plugins depending on it.
 *
 * @param {any} ...dependentPlugins
 *
 * @returns {* | Promise<*>}
 */
 create: () => {
 return new Promise(resolve => {
 setTimeout(() => {
 resolve({
 foo: "bar",
 })
 }, 50)
 })
 },
}

export default {
 depend: ["PluginOne"],
 name: "Plugin2",
 create: PluginOne => ({
 lorem: `ipsum ${PluginOne.foo}`,
 }),
}

import { pluginus } from "@asd14/pluginus"
pluginus({
 source: ["path-to-plugin1", "path-to-plugin2"],
}).then(({ PluginOne, Plugin2 }) => {
 // PluginOne
 // => {
 // foo: "bar",
 // }
 // Plugin2
 // => {
 // lorem: "ipsum bar",
 // }
})

Develop

git clone git@github.com:asd-xiv/pluginus.git && \
 cd pluginus && \
 npm run setup

npm test

npm run tdd

Changelog