wassname/talk
1
0
Fork 0
mirror of https://github.com/wassname/talk.git synced 2026-07-20 12:40:47 +08:00
Code Issues Packages Projects Releases Wiki Activity

Adjusted plugins.json format, added docs

Browse Source
This commit is contained in:
Wyatt Johnson
2017-04-03 08:53:40 -06:00
parent c221dbb4a0
commit d4c7dac945
2 changed files with 47 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
PLUGINS.md
+23 -1
View File
@@ -9,7 +9,7 @@ All plugins must be registered in the root file `plugins.json`.
The format for this file is thus:
```js
```json
{
"server": [
"people"
@@ -22,6 +22,28 @@ name in the `plugins/` folder. For example, the above `plugins.json` would
require a plugin from `plugins/people`, which must provide a `index.js` file
that returns an object that matches the Plugin Specification.
If the package is external (available on NPM) you can specify the string for
the version by using an object instead, for example:
```json
{
"server": [
{"people": "^1.2.0"}
]
}
```
External plugins can be resolved by running:
```bash
./bin/cli plugins reconcile
```
This will also traverse into local plugin folders and install their
dependancies. _Note that if the plugin is already installed and available in the
node_modules folder, it will not be fetched again unless there is a version
mismatch._
## Server Plugins
### Specification
plugins.js
+24 -14
View File
@@ -51,36 +51,46 @@ function pluginPath(name) {
* Stores a reference to a section for a section of Plugins.
*/
class PluginSection {
constructor(plugin_names) {
this.plugins = Object.keys(plugin_names).map((plugin_name) => {
constructor(plugins) {
this.plugins = plugins.map((p) => {
let plugin = {};
// Get the version/folder that was specified.
plugin.version = plugin_names[plugin_name];
// This checks to see if the structure for this entry is an object:
//
// {"people": "^1.2.0"}
//
// otherwise it's checked whether it matches the local version:
//
// "people"
//
if (typeof p === 'object') {
plugin.name = Object.keys(p).find((name) => name !== null);
plugin.version = p[plugin.name];
} else if (typeof p === 'string') {
plugin.name = p;
} else {
throw new Error(`plugins.json is malformed, refer to PLUGINS.md for formatting, expected a string or an object for a plugin entry, found a ${typeof p}`);
}
// Get the path for the plugin.
plugin.path = pluginPath(plugin_name);
plugin.path = pluginPath(plugin.name);
if (typeof plugin.path === 'undefined') {
throw new Error(`plugin '${plugin_name}' is not local or is not symlinked from your node_modules directory, plugin reconsiliation may be required`);
throw new Error(`plugin '${plugin.name}' is not local or is not symlinked from your node_modules directory, plugin reconsiliation may be required`);
}
try {
plugin.module = require(plugin.path);
} catch (e) {
throw new Error(`plugin '${plugin_name}' could not be required from '${plugin.path}': ${e.message}`);
throw new Error(`plugin '${plugin.name}' could not be required from '${plugin.path}': ${e.message}`);
}
if (isInternal(plugin_name)) {
debug(`loading internal plugin '${plugin_name}' from '${plugin.path}'`);
if (isInternal(plugin.name)) {
debug(`loading internal plugin '${plugin.name}' from '${plugin.path}'`);
} else {
debug(`loading external plugin '${plugin_name}' from '${plugin.path}'`);
debug(`loading external plugin '${plugin.name}' from '${plugin.path}'`);
}
// Ensure we have a default plugin name, but allow the name to be
// overrided by the plugin.
plugin.name = plugin.name || plugin_name;
return plugin;
});
}