lib/plugins/plugin.js


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

var path = require('path');
var resolve = require('resolve');

var Promise = require('../utils/promise');

var PLUGIN_PREFIX = 'gitbook-plugin-';

// Return an absolute name for the plugin (the one on NPM)
function npmId(name) {
    if (name.indexOf(PLUGIN_PREFIX) === 0) return name;
    return [PLUGIN_PREFIX, name].join('');
}


function BookPlugin(book, pluginId) {
    this.book = book;
    this.id = pluginId;
    this.npmId = npmId(pluginId);

    this.packageInfos = undefined;
    this.content = undefined;

}

// Return true if plugin has been loaded correctly
BookPlugin.prototype.isLoaded = function() {
    return Boolean(this.packageInfos && this.content);
};

// Load this plugin
BookPlugin.prototype.load = function() {
    var that = this;

    if (this.isLoaded()) {
        return Promise.reject(new Error('Plugin "' + this.id + '" is already loaded'));
    }

    // Try loading plugins from different location
    return Promise.some([
        this.book.resolve('node_modules'),
        __dirname
    ], function(baseDir) {
        try {
            var res = resolve.sync(name+'/package.json', { basedir: baseDir });

            that.baseDir = path.dirname(res);
            that.packageInfos = require(res);
            that.content = require(resolve.sync(name, { basedir: baseDir }));

            return true;
        } catch (err) {
            if (err.code != 'MODULE_NOT_FOUND') throw(err);

            that.packageInfos = undefined;
            that.content = undefined;

            return false;
        }
    })

    .then(function() {
        if (!that.isLoaded()) {
            throw new Error('Couldn\'t locate plugin "' + that.id + '", Run \'gitbook install\' to install plugins from registry.');
        }
    });
};

module.exports = BookPlugin;