changed the way nodejs packages are created

Author: bobvanderlinden

.gitignore

@@ -1 +1,3 @@
 build
+node_modules
+

.npmignore

@@ -0,0 +1,6 @@
+*
+!js
+!build/js/**
+!package.json
+!README*
+!LICENSE*

Makefile

@@ -41,27 +41,9 @@ PYGEN    := $(BUILDDIR)/python
 # generated Documentation files
 DOCGEN := $(BUILDDIR)/doc
 
-# disable protobuf.js per default
-PROTOBUFJS := 0
-
-# directory for ProtoBuf.js generated files
-PROTOBUFJS_GEN := $(BUILDDIR)/js
-
-# the proto2js compiler
-PROTOJS := $(shell which proto2js)
-
 # pkg-config
 PKG_CONFIG := $(shell which pkg-config)
 
-# proto2js options - namespace
-#PROTOBUFJS_OPT := -commonjs=pb
-# http://en.wikipedia.org/wiki/Asynchronous_module_definition
-#PROTOBUFJS_OPT := -amd
-PROTOBUFJS_OPT := -class
-
-# protobuf namespace; all protos except nanopb.proto
-JSNAMESPACE := =pb
-
 # the set of all proto specs generated files depend on
 PROTO_SPECS := $(wildcard $(PROTODIR)/*.proto)
 
@@ -91,10 +73,6 @@ PROTO_CXX_INCS := ${PROTO_SPECS:$(SRCDIR)/%.proto=$(CXXGEN)/%.pb.h}
 # generated C++ sources
 PROTO_CXX_SRCS  :=  ${PROTO_SPECS:$(SRCDIR)/%.proto=$(CXXGEN)/%.pb.cc}
 
-# generated Javasript sources
-PROTO_PROTOBUFJS_SRCS  := ${PROTO_SPECS:$(SRCDIR)/%.proto=$(PROTOBUFJS_GEN)/%.js}
-
-
 # ---- generate dependcy files for .proto files
 #
 # the list of .d dep files for .proto files:
@@ -106,7 +84,6 @@ PBDEP_OPT :=
 #PBDEP_OPT += --debug
 PBDEP_OPT += --cgen=$(CXXGEN)
 PBDEP_OPT += --pygen=$(PYGEN)
-PBDEP_OPT += --jsgen=$(PROTOBUFJS_GEN)
 # this path must match the vpath arrangement exactly or the deps will be wrong
 # unfortunately there is no way to extract the proto path in the code
 # generator plugin
@@ -121,10 +98,6 @@ GENERATED += \
 	$(PROTO_PY_TARGETS) \
 	$(PROTO_PY_EXTRAS)
 
-ifeq ($(PROTOBUFJS),1)
-GENERATED += $(PROTO_PROTOBUFJS_SRCS) $(PROTOBUFJS_GEN)/nanopb.js
-endif
-
 $(OBJDIR)/%.d: $(SRCDIR)/%.proto
 	$(ECHO) "protoc create dependencies for $<"
 	@mkdir -p $(OBJDIR)/
@@ -180,32 +153,6 @@ $(DOCGEN)/%.md: $(SRCDIR)/%.proto
 	--doc_out=markdown,$@:./ \
 	$<
 
-# ------------- ProtoBuf.js rules ------------
-#
-# see https://github.com/dcodeIO/ProtoBuf.js
-#
-# generate Javascript modules from proto files
-#=$(filter-out %/butterfly.ngc,$(call GLOB,../nc_files/*))
-
-$(PROTOBUFJS_GEN)/%.js: $(SRCDIR)/%.proto
-	$(ECHO) $(PROTOJS)" create $@ from $<"
-	@mkdir -p $(PROTOBUFJS_GEN)
-	$(Q)$(PROTOJS) 	$< \
-	$(PROTOBUFJS_OPT)$(JSNAMESPACE) \
-	> $@
-
-# everything is namespace pb except nanopb.proto
-# # nanopb.proto needs different opts - no namespace argument
-ifeq ($(PROTOBUFJS),1)
-$(PROTOBUFJS_GEN)/nanopb.js: $(PROTODIR)/nanopb.proto
-	# $(ECHO) "HALLO"
-	# $(ECHO) $(PROTOJS)" create $@ from $<"
-	@mkdir -p $(PROTOBUFJS_GEN)
-	$(Q)$(PROTOJS) 	$< \
-	$(PROTOBUFJS_OPT) \
-	> $@
-endif
-
 # force create of %.proto-dependent files and their deps
 Makefile: $(GENERATED) $(PROTO_DEPS)
 -include $(PROTO_DEPS)

README.javascript

@@ -18,3 +18,37 @@ git subtree merge --prefix=src/machinetalk/proto machinetalk-protobuf/master --s
 `````
 
 Now create a PR against the machinekit repo.
+
+## Javascript (NPM/NodeJS)
+
+### Installation
+
+To use machinetalk protobuf definitions in your npm-based projects, use:
+
+```sh
+npm install --save machinetalk-protobuf
+```
+
+### Usage
+
+See [examples](js/examples). If you want to try these examples, be sure to first run `npm install` in this repository.
+
+#### Encoding
+
+```js
+var machinetalkProtobuf = require('machinetalk-protobuf');
+var messageContainer = {
+  type: machinetalkProtobuf.message.ContainerType.MT_PING
+};
+var encodedMessageContainer = machinetalkProtobuf.message.Container.encode(messageContainer);
+```
+This results in a buffer that starts with `0x08 0xd2 0x01`.
+
+#### Decoding
+
+```js
+var machinetalkProtobuf = require('machinetalk-protobuf');
+var encodedBuffer = new Buffer([0x08, 0xd2, 0x01]);
+var decodedMessageContainer = machinetalkProtobuf.message.Container.decode(encodedBuffer);
+```
+This results in a messageContainer like the one defined in [Encoding](#Encoding).

README.md

@@ -0,0 +1,9 @@
+var machinetalkProtobuf = require('../index.js');
+
+var encodedBuffer = new Buffer([0x08, 0xd2, 0x01]);
+
+// Decode the message.
+var decodedMessageContainer = machinetalkProtobuf.message.Container.decode(encodedBuffer);
+
+// decodedMessageContainer.type === machinetalkProtobuf.message.ContainerType.MT_PING
+console.log(decodedMessageContainer);

js/examples/decoding_message_container.js

@@ -0,0 +1,15 @@
+var machinetalkProtobuf = require('../index.js');
+
+// Define the message we want to encode.
+var messageContainer = {
+  type: machinetalkProtobuf.message.ContainerType.MT_PING
+};
+
+// Encode the message.
+var encodedMessageContainer = machinetalkProtobuf.message.Container.encode(messageContainer);
+
+// Strip off excess bytes from the resulting buffer.
+var encodedBuffer = encodedMessageContainer.buffer.slice(encodedMessageContainer.offset, encodedMessageContainer.limit);
+
+// Print the buffer.
+console.log(encodedBuffer);

js/examples/encoding_message_container.js

@@ -0,0 +1,5 @@
+var protoNames = require('../build/js/protonames.json');
+
+protoNames.forEach(function(proto) {
+  module.exports[proto.name] = require('../build/js/' + proto.fullname + '.js').pb;
+});

js/index.js

@@ -0,0 +1,45 @@
+#!/usr/bin/env node
+var path = require('path');
+var fs = require('fs');
+var mkdirp = require('mkdirp');
+var child_process = require('child_process');
+var sourcePath = path.join(__dirname, '/../../src');
+var destinationPath = path.join(__dirname, '/../../build/js');
+
+var namespace = 'machinetalk/protobuf';
+
+// Create list of information for protobuf files.
+var protos = fs.readdirSync(path.join(sourcePath, namespace))
+  .filter(function(filename) {
+    // Only handle .proto files.
+    return /\.proto$/.test(filename);
+  })
+  .map(function(filename) {
+    var name = path.basename(filename, '.proto');
+    var fullname = path.join(namespace, name);
+    return {
+      filename: filename,
+      name: name,
+      fullname: fullname,
+      protopath: path.join(sourcePath, namespace, filename),
+      jspath: path.join(destinationPath, namespace, name + '.js')
+    };
+  });
+
+// Generate js file for each proto file
+protos.forEach(function(protos) {
+  mkdirp.sync(path.dirname(protos.jspath));
+  child_process.execFileSync('pbjs', ['--target', 'commonjs', '--out', protos.jspath, '--path', sourcePath, protos.protopath]);
+});
+
+
+// Generate json file to direct index.js to the generated js files.
+var protosjson = protos.map(function(proto) {
+  return {
+    name: proto.name,
+    fullname: proto.fullname
+  };
+});
+
+mkdirp.sync(destinationPath);
+fs.writeFileSync(path.join(destinationPath, 'protonames.json'), JSON.stringify(protosjson));

js/scripts/install.js

@@ -0,0 +1,28 @@
+{
+  "name": "machinetalk-protobuf",
+  "version": "1.0.1",
+  "description": "Protobuf definitions to communicate with Machinetalk",
+  "main": "js/index.js",
+  "scripts": {
+    "prepublish": "js/scripts/install.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/machinekit/machinetalk-protobuf.git"
+  },
+  "author": "Bob van der Linden <[email protected]>",
+  "keywords": [
+    "machinetalk",
+    "machinekit",
+    "protobuf"
+  ],
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/machinekit/machinetalk-protobuf/issues"
+  },
+  "homepage": "https://github.com/machinekit/machinetalk-protobuf#readme",
+  "dependencies": {
+    "mkdirp": "0.5.1",
+    "protobufjs": "5.0.0"
+  }
+}