summaryrefslogtreecommitdiffstats
path: root/packages/gitbook/lib/api/encodeConfig.js
diff options
context:
space:
mode:
Diffstat (limited to 'packages/gitbook/lib/api/encodeConfig.js')
-rw-r--r--packages/gitbook/lib/api/encodeConfig.js36
1 files changed, 36 insertions, 0 deletions
diff --git a/packages/gitbook/lib/api/encodeConfig.js b/packages/gitbook/lib/api/encodeConfig.js
new file mode 100644
index 0000000..2a05528
--- /dev/null
+++ b/packages/gitbook/lib/api/encodeConfig.js
@@ -0,0 +1,36 @@
+var objectPath = require('object-path');
+var deprecate = require('./deprecate');
+
+/**
+ Encode a config object into a JS config api
+
+ @param {Output} output
+ @param {Config} config
+ @return {Object}
+*/
+function encodeConfig(output, config) {
+ var result = {
+ values: config.getValues().toJS(),
+
+ get: function(key, defaultValue) {
+ return objectPath.get(result.values, key, defaultValue);
+ },
+
+ set: function(key, value) {
+ return objectPath.set(result.values, key, value);
+ }
+ };
+
+ deprecate.field(output, 'config.options', result, 'options',
+ result.values, '"config.options" property is deprecated, use "config.get(key)" instead');
+
+ deprecate.field(output, 'config.options.generator', result.values, 'generator',
+ output.getGenerator(), '"options.generator" property is deprecated, use "output.name" instead');
+
+ deprecate.field(output, 'config.options.generator', result.values, 'output',
+ output.getRoot(), '"options.output" property is deprecated, use "output.root()" instead');
+
+ return result;
+}
+
+module.exports = encodeConfig;