summaryrefslogtreecommitdiffstats
path: root/lib/plugins/context.js
diff options
context:
space:
mode:
Diffstat (limited to 'lib/plugins/context.js')
-rw-r--r--lib/plugins/context.js24
1 files changed, 24 insertions, 0 deletions
diff --git a/lib/plugins/context.js b/lib/plugins/context.js
new file mode 100644
index 0000000..51649aa
--- /dev/null
+++ b/lib/plugins/context.js
@@ -0,0 +1,24 @@
+var error = require('../utils/error');
+
+/*
+ Return the context for a plugin.
+ It tries to keep compatibilities with GitBook v2
+*/
+
+function pluginCtx(plugin) {
+ var book = plugin.book;
+ var ctx = {
+ config: book.config,
+ log: plugin.log,
+
+ // Paths
+ resolve: book.resolve
+ };
+
+ // Deprecation
+ error.deprecateField(ctx, 'options', book.config.dump(), '"options" property is deprecated, use config.get(key) instead');
+
+ return ctx;
+}
+
+module.exports = pluginCtx;