Added simple CommonJS and AMD wrappers, see #540; Refactored json/static-module targets to use common wrappers

Author: dcodeIO

README.md

@@ -342,7 +342,13 @@ Consolidates imports and converts between file formats.
 
   -o, --out       Saves to a file instead of writing to stdout.
 
-  -w, --wrap      Specifies an alternative wrapper for any *-module target.
+  -w, --wrap      Specifies the wrapper to use for *-module targets. Also accepts a path.
+
+                  default   Default wrapper supporting both CommonJS and AMD
+                  commonjs  CommonJS only wrapper
+                  amd       AMD only wrapper
+
+  -r, --root      Specifies an alternative protobuf.roots name for *-module targets.
 
 usage: pbjs [options] file1.proto file2.json ...
 ```

cli/pbjs.js

@@ -31,7 +31,7 @@ exports.main = function(args) {
         paths  = typeof argv.path === 'string' ? [ argv.path ] : argv.path || [];
 
     if (!files.length) {
-        var descriptions = Object.keys(targets).filter(function(key) { return !targets[key].private; }).map(function(key) {
+        var descs = Object.keys(targets).filter(function(key) { return !targets[key].private; }).map(function(key) {
             return "                  " + util.pad(key, 14, true) + targets[key].description;
         });
         console.log([
@@ -41,13 +41,17 @@ exports.main = function(args) {
             "",
             "  -t, --target    Specifies the target format. Also accepts a path to require a custom target.",
             "",
-            descriptions.join('\n'),
+            descs.join('\n'),
             "",
             "  -p, --path      Adds a directory to the include path.",
             "",
             "  -o, --out       Saves to a file instead of writing to stdout.",
             "",
-            "  -w, --wrap      Specifies an alternative wrapper for *-module targets.",
+            "  -w, --wrap      Specifies the wrapper to use for *-module targets. Also accepts a path.",
+            "",
+            "                  default   Default wrapper supporting both CommonJS and AMD",
+            "                  commonjs  CommonJS only wrapper",
+            "                  amd       AMD only wrapper",
             "",
             "  -r, --root      Specifies an alternative protobuf.roots name for *-module targets.",
             "",

cli/targets/json-module.js

@@ -10,9 +10,10 @@ var protobuf = require("../..");
 json_module.description = "JSON representation as a module (AMD, CommonJS, global)"
 
 function json_module(root, options, callback) {
+
     try {
-        var output = JSON.stringify(root, null, 2).replace(/^(?!$)/mg, "    ").trim();
-        output = util.wrap(options.wrap || "json-module", output, options.root);
+        var output = "var $root = protobuf.Root.fromJSON(" + JSON.stringify(root, null, 2).replace(/^(?!$)/mg, "    ").trim() + ");";
+        output = util.wrap(options.wrap || "default", output, options.root);
         process.nextTick(function() {
             callback(null, output);
         });

cli/targets/static-module.js

@@ -19,7 +19,7 @@ function static_module_target(root, options, callback) {
         if (err)
             return callback(err);
         try {
-            output = util.wrap(options.wrap || "static-module", output, options.root);
+            output = util.wrap(options.wrap || "default", output, options.root);
         } catch (e) {
             callback(e);
             return;

cli/wrappers/amd.js

@@ -0,0 +1,9 @@
+define(["protobuf"], function($protobuf) {
+    "use strict"; // eslint-disable-line strict
+
+    %OUTPUT%
+
+    $protobuf.roots[%ROOT%] = $root;
+
+    return $root;
+});

cli/wrappers/commonjs.js

@@ -0,0 +1,9 @@
+"use strict"; // eslint-disable-line strict
+
+var $protobuf = require("protobufjs/runtime");
+
+%OUTPUT%
+
+$protobuf.roots[%ROOT%] = $root;
+
+module.exports = $root;