summaryrefslogtreecommitdiffstats
path: root/lib/plugins/loadPlugin.js
diff options
context:
space:
mode:
authorSamy Pessé <samypesse@gmail.com>2016-04-22 11:00:21 +0200
committerSamy Pessé <samypesse@gmail.com>2016-04-22 11:00:21 +0200
commit4336fdb2414d460ffee68a0cc87c0cb0c85cf56e (patch)
tree279f711ab98666c892c19a7b9e4073a094f03f98 /lib/plugins/loadPlugin.js
parent87db7cf1d412fa6fbd18e9a7e4f4755f2c0c5547 (diff)
downloadgitbook-4336fdb2414d460ffee68a0cc87c0cb0c85cf56e.zip
gitbook-4336fdb2414d460ffee68a0cc87c0cb0c85cf56e.tar.gz
gitbook-4336fdb2414d460ffee68a0cc87c0cb0c85cf56e.tar.bz2
Base
Diffstat (limited to 'lib/plugins/loadPlugin.js')
-rw-r--r--lib/plugins/loadPlugin.js89
1 files changed, 89 insertions, 0 deletions
diff --git a/lib/plugins/loadPlugin.js b/lib/plugins/loadPlugin.js
new file mode 100644
index 0000000..a0dac5f
--- /dev/null
+++ b/lib/plugins/loadPlugin.js
@@ -0,0 +1,89 @@
+var path = require('path');
+var resolve = require('resolve');
+
+var Promise = require('../utils/promise');
+var error = require('../utils/error');
+
+var validatePlugin = require('./validatePlugin');
+
+// Return true if an error is a "module not found"
+// Wait on https://github.com/substack/node-resolve/pull/81 to be merged
+function isModuleNotFound(err) {
+ return err.message.indexOf('Cannot find module') >= 0;
+}
+
+/**
+ Load a plugin in a book
+
+ @param {Book} book
+ @param {Plugin} plugin
+ @param {String} pkgPath (optional)
+ @return {Promise<Plugin>}
+*/
+function loadPlugin(book, plugin) {
+ var logger = book.getLogger();
+
+ var name = plugin.getName();
+ var pkgPath = plugin.getPath();
+
+
+ // Try loading plugins from different location
+ var p = Promise()
+ .then(function() {
+ var packageContent;
+ var content;
+
+ // Locate plugin and load pacjage.json
+ try {
+ var res = resolve.sync('./package.json', { basedir: pkgPath });
+
+ pkgPath = path.dirname(res);
+ packageContent = require(res);
+ } catch (err) {
+ if (!isModuleNotFound(err)) throw err;
+
+ packageContent = undefined;
+ content = undefined;
+
+ return;
+ }
+
+ // Load plugin JS content
+ try {
+ content = require(pkgPath);
+ } catch(err) {
+ // It's no big deal if the plugin doesn't have an "index.js"
+ // (For example: themes)
+ if (isModuleNotFound(err)) {
+ content = {};
+ } else {
+ throw new error.PluginError(err, {
+ plugin: name
+ });
+ }
+ }
+
+ // Update plugin
+ return plugin.merge({
+ 'package': packageContent,
+ 'content': content
+ });
+ })
+
+ .then(validatePlugin)
+
+ // Validate the configuration and update it
+ .then(function() {
+ var config = that.book.config.get(that.getConfigKey(), {});
+ return that.validateConfig(config);
+ })
+ .then(function(config) {
+ that.book.config.set(that.getConfigKey(), config);
+ });
+
+ logger.info('loading plugin "' + name + '"... ');
+ return logger.info.promise(p);
+}
+
+
+module.exports = loadPlugin;