framework-factory/plugin-templates/--plugin-template-function--.js

A wonderful factory framwork for creating modern object oriented javascript libraries.

function main(FrameworkFactory) {

    /**
     * Called when a new framework ($f) is created
     * @function plugin($f)
     * @param  {[type]} $f The new framework.
     */
    function plugin($f) {
        // TODO: Code to attach framework related code goes here.
        // Example:
        // $f.pluginFunction = function(){...}
    }

    //Optional information.
    
    plugin.info = {

        /**
         * The name of the plugin, mandatory.
         */
        name: "MyPlugin"
        
        /**
         * The plugin version.
         */
        version: "1.0",

        /**
         * The plugin author.
         */
        author: "Your Name",

        /**
         * The plugin url.
         */
        url: "http://www.ff-plugin.com"

    };

    
    //Register plugin with FrameworkFactory. Registration enables plugin's function
    //to be invoked each time a new framework is created.
    FrameworkFactory.plugins.register(plugin);
}

//Load environment
if (typeof module !== "undefined" && typeof module.exports === "object") {
    module.exports = main;
}
else {
    main(this.FrameworkFactory);
}