Added json-module target to pbjs, renamed static to static-module, see #522

Author: dcodeIO

cli/pbjs.js

@@ -30,19 +30,23 @@ 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) {
+            return "                  " + util.pad(key, 14, true) + targets[key].description;
+        });
         console.log([
             "protobuf.js v" + pkg.version + " cli",
             "",
             "Consolidates imports and converts between file formats.",
             "",
-            "  -t, --target    Specifies the target format. [" + Object.keys(targets).filter(function(key) { return !targets[key].private; }).join(', ') + "]",
-            "                  Also accepts a path to require a custom target.",
+            "  -t, --target    Specifies the target format. Also accepts a path to require a custom target.",
+            "",
+            descriptions.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 the static target.",
+            "  -w, --wrap      Specifies an alternative wrapper for any *-module target.",
             "",
             "usage: " + chalk.bold.green(path.basename(process.argv[1])) + " [options] file1.proto file2.json ..."
         ].join("\n"));

cli/targets/json-module.js

@@ -0,0 +1,18 @@
+"use strict";
+module.exports = json_modulee;
+
+var path = require("path"),
+    fs   = require("fs");
+
+var protobuf = require("../..");
+
+json_modulee.description = "JSON representation as a module (AMD, CommonJS, global)"
+
+function json_modulee(root, options, callback) {
+    if (options.wrap)
+        options.wrap = path.resolve(process.cwd(), options.wrap);
+    else
+        options.wrap = path.join(__dirname, "json-module.tpl");
+    var wrap = fs.readFileSync(options.wrap).toString("utf8");
+    callback(null, wrap.replace(/%OUTPUT%/, JSON.stringify(root, null, 2)));    
+}

cli/targets/json-module.tpl

@@ -0,0 +1,16 @@
+!(function(global, factory) {
+
+    /* AMD */ if (typeof define === 'function' && define.amd)
+        define(["protobuf"], factory);
+    
+    /* CommonJS */ else if (typeof require === 'function' && typeof module === 'object' && module && module.exports)
+        module.exports = factory(require("protobufjs"));
+    
+    /* Global */ else
+        global.root = factory(global.protobuf);
+
+})(this, function(protobuf) { return protobuf.Root.fromJSON(
+
+%OUTPUT%
+
+);});

cli/targets/json.js

@@ -3,6 +3,8 @@ module.exports = json_target;
 
 var protobuf = require("../..");
 
+json_target.description = "JSON representation"
+
 function json_target(root, options, callback) {
     callback(null, JSON.stringify(root, null, 2));    
 }

cli/targets/proto2.js

@@ -3,6 +3,8 @@ module.exports = proto2_target;
 
 var protobuf = require("../..");
 
+proto2_target.description = "Protocol Buffers, Version 2";
+
 function proto2_target(root, options, callback) {
     require("./proto")(root, protobuf.util.merge(options, { syntax: "proto2" }), callback);
 }

cli/targets/proto3.js

@@ -3,6 +3,8 @@ module.exports = proto3_target;
 
 var protobuf = require("../..");
 
+proto3_target.description = "Protocol Buffers, Version 3";
+
 function proto3_target(root, options, callback) {
     require("./proto")(root, protobuf.util.merge(options, { syntax: "proto3" }), callback);
 }

cli/targets/static.js cli/targets/static-module.jscli/targets/static.js renamed to cli/targets/static-module.js

@@ -24,11 +24,13 @@ var Type      = protobuf.Type,
 var out = [];
 var indent = 0;
 
+static_target.description = "Static code without reflection as a module (AMD, CommonJS, global)";
+
 function static_target(root, options, callback) {
     if (options.wrap)
         options.wrap = path.resolve(process.cwd(), options.wrap);
     else
-        options.wrap = path.join(__dirname, "static.tpl");
+        options.wrap = path.join(__dirname, "static-module.tpl");
     try {
         var wrap = fs.readFileSync(options.wrap).toString("utf8");
         ++indent;

cli/targets/static.tpl cli/targets/static-module.tplcli/targets/static.tpl renamed to cli/targets/static-module.tpl

@@ -1,4 +1,4 @@
-;(function(global, factory) {
+!(function(global, factory) {
 
     /* AMD */ if (typeof define === 'function' && define.amd)
         define(["protobuf"], factory);

cli/util.js

@@ -69,3 +69,9 @@ exports.require = function(name, version) {
     }
     return require(name);
 };
+
+exports.pad = function(str, len, l) {
+    while (str.length < len)
+        str = l ? str + " " : " " + str;
+    return str;
+};