Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bhou/fx-runtime


https://github.com/bhou/fx-runtime

Last synced: about 2 months ago
JSON representation

Awesome Lists containing this project

README 

        
README.md



# fx-runtime



## Description

**Wavelet** runtime, manages plugins.



## Usage

`````javascript

var runtime = require('fx-runtime');

var dir = __dirname; // reference dir for config and plugins

var config = 'your config file, related to your home';



runtime.start(dir, config, function() {

    console.log('Usage: yourapp [Options]');

    console.log('Options:');

    // TODO: add you options here

    console.log('');

});

`````



You can also pass an array object to as the config

`````javascript

var runtime = require('fx-runtime');

var dir = __dirname; // reference dir for config and plugins

var config = [

    {

        packagePath: "plugin A's package path",

        // other options here

    },

    {

        packagePath: "plugin B's package path",

        // other options here

    }

];



runtime.start(dir, config, function() {

    console.log('Usage: yourapp [Options]');

    console.log('Options:');

    // TODO: add you options here

    console.log('');

});

`````



Config argument could be a function too:

`````javascript

var runtime = require('fx-runtime');

var dir = __dirname; // reference dir for config and plugins

var function getConfig() { 

    return [

        {

            packagePath: "plugin A's package path",

            // other options here

        },

        {

            packagePath: "plugin B's package path",

            // other options here

        }

    ]

};



runtime.start(dir, getConfig, function() {

    console.log('Usage: yourapp [Options]');

    console.log('Options:');

    // TODO: add you options here

    console.log('');

});

`````



Automatically resolve config and help

`````javascript

var runtime = require('fx-runtime');



var defaultConfig = require('./config.json');



var pluginPaths = [

    __dirname + '/node_modules'

];



var preDefinedHelp = {

  "--help": "print help"

  // other help information

};



var filter = {

  "whiteList": [], // plugin white list, or set it to null

  "blackList": [] // plugin black list, or set it to null

}



var plugins = runtime.resolvePlugins(pluginPaths, defaultConfig, preDefinedHelp, filter);



runtime.start(__dirname, plugins.config, function() {

    console.log('Usage: wavelet [optins]');

    console.log('Options:');

    // TODO: add your options here



    console.log('Plugin Options:');



    for (var i = 0; i < plugins.help.length; i++) {

        console.log(plugins.help[i]);

    }

    

    console.log('');

});

`````



## Registered global variables

**Wavelet** runtime registers several global variables, you need to avoid overriding them.



### Variable: home 

[String] The location where wavelet is installed, **home** will be used to locate the config file, the plugins and other resources



### Variable: runtime

[Object] **runtime** provides runtime APIs:



#### runtime.getService([string] service)

get the instance of service or null if not found. Do not use this api unless you have to. This api breaks the plugin dependencies. Best practice: Depend on a plugin that provides this service.



#### runtime.resolvePlugins([array] searchPath, [object] defaultConfig, [object] defaultHelp)

search plugin configurations and help informations in the search path array. The plugin configuration is defined in package.json file as "plugin-config". The plugin arguments is defined in package.json file as "plugin-args". This API returns an object with two properties: 



- config: the config of plugins

- help: the argument description of plugins



You can pass *config* as the second parameter of *runtime.start*. And print the help out in the third argument of *runtime.start*



## Plugin

**Wavelet** is based on [architect](https://github.com/c9/architect), and provides additional APIs and tools. An architect plugin could be directly used in **Wavelet**. 



### service

A plugin could **consume** services provided from other plugins, and **provides** services to others.



You can use the online **Wavelet** service registry to find services and the plugins that implement it.