Makefile

PROTOC_GEN_TS_PATH=${HOME}/.npm_modules/bin/protoc-gen-ts

.PHONY: proto
proto: proto-gen tidy

# -I are the import paths, because we're using some plugins, we need to import the gogo protobuf helpers
.PHONY: proto-gen
proto-gen: gen-file gen-util gen-status gen-pubsub gen-admin gen-namesys gen-node gen-replication gen-docs


# builds the static website
.PHONY: build-docs
build-docs:
	bundle exec jekyll build
	
# serve the docs locally, requires properly installing jekyll
.PHONY: serve-docs
serve-docs:
	bundle exec jekyll serve

# installs dependencies needed to serve docs locally
.PHONY: install-docs
install-docs:
	gem install github-pages
	bundle install

# run standard go tooling for better readability
.PHONY: tidy
tidy: imports fmt
	go vet ./...
	golint ./...

# automatically add missing imports
.PHONY: imports
imports:
	find . -type f -name '*.go' -exec goimports -w {} \;

# format code and simplify if possible
.PHONY: fmt
fmt:
	find . -type f -name '*.go' -exec gofmt -s -w {} \;

# install supplementary tooling
.PHONY: install
install:
	go get -u github.com/gogo/protobuf/protoc-gen-gogoslick
	go get -u github.com/gogo/protobuf/protoc-gen-gogofaster
	go get -u github.com/gogo/protobuf/protoc-gen-gogofast
	go get -u github.com/gogo/protobuf/protoc-gen-gogo
	go get -u github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway
	go get -u github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger
	go get -u github.com/mwitkow/go-proto-validators/protoc-gen-govalidators
	go get -u github.com/gogo/protobuf/proto
	go get -u github.com/gogo/protobuf/gogoproto
	go get -u github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc
	npm install -g ts-protoc-gen
	npm install -g grpc
	npm install -g @grpc/proto-loader
	npm install -g grpc-tools
	python3 -m pip install grpcio-tools
	bash .script/protoc-js.sh
	cargo install protobuf-codegen
	cargo install grpcio-compiler

# protocol buffer generation targets

gen-file:
	# generate golang bindings (file)
	protoc \
		-I=pb \
		-I=${GOPATH}/src \
		pb/file.proto \
		--gogofaster_out=plugins=grpc:go
	# generate python bindings (file)
	python3 -m grpc_tools.protoc \
		-I=pb \
		-I=${GOPATH}/src \
		pb/file.proto \
		--python_out=py \
		--grpc_python_out=py
	# generate typescript bindings (file)
	protoc \
		--plugin="protoc-gen-ts=${PROTOC_GEN_TS_PATH}" \
		-I=pb \
		-I=${GOPATH}/src \
		--ts_out=service=grpc-web:ts \
		pb/file.proto
	# generate javascript bindings (file)
	protoc \
		-I=pb \
		-I=${GOPATH}/src \
		--js_out=import_style=commonjs,binary:js \
		--grpc_out=js \
		--plugin=protoc-gen-grpc=`which grpc_tools_node_protoc_plugin` \
		pb/file.proto
	# generate java bindings (file)
	protoc \
		-I=pb \
		-I=${GOPATH}/src \
		--plugin=protoc-gen-grpc-java=build/protoc-gen-grpc-java \
  		--grpc-java_out=java \
		pb/file.proto
    # generate rust bindings (file)
	protoc \
		-I=pb \
		-I=${GOPATH}/src \
		--rust_out=rs/src \
		--grpc_out=rs/src \
		--plugin=protoc-gen-grpc=`which grpc_rust_plugin` \
		pb/file.proto

gen-util:
	# generate golang bindings (util)
	protoc \
		-I=pb \
		-I=${GOPATH}/src \
		pb/util.proto \
		--gogofaster_out=plugins=grpc:go
	# generate python bindings (util)  no grpc bindings for this so --grpc_python_out is omitted
	python3 -m grpc_tools.protoc \
		-I=pb \
		-I=${GOPATH}/src \
		pb/util.proto \
		--python_out=py
	# generate typescript bindings (util)
	protoc \
		--plugin="protoc-gen-ts=${PROTOC_GEN_TS_PATH}" \
		-I=pb \
		-I=${GOPATH}/src \
		--ts_out=service=grpc-web:ts \
		pb/util.proto
	# generate javascript bindings (util)
	protoc \
		-I=pb \
		-I=${GOPATH}/src \
		--js_out=import_style=commonjs,binary:js \
		--grpc_out=js \
		--plugin=protoc-gen-grpc=`which grpc_tools_node_protoc_plugin` \
		pb/util.proto
	# generate java bindings (util)
	protoc \
		-I=pb \
		-I=${GOPATH}/src \
		--plugin=protoc-gen-grpc-java=build/protoc-gen-grpc-java \
  		--grpc-java_out=java \
		pb/util.proto
    # generate rust bindings (util)
	protoc \
		-I=pb \
		-I=${GOPATH}/src \
		--rust_out=rs/src \
		--grpc_out=rs/src \
		--plugin=protoc-gen-grpc=`which grpc_rust_plugin` \
		pb/util.proto


gen-node:
	# generate golang bindings (node)
	protoc \
		-I=pb \
		-I=${GOPATH}/src \
		pb/node.proto \
		--gogofaster_out=plugins=grpc:go
	# generate python bindings (node)
	python3 -m grpc_tools.protoc \
		-I=pb \
		-I=${GOPATH}/src \
		pb/node.proto \
		--python_out=py \
		--grpc_python_out=py
	# generate typescript bindings (node)
	protoc \
		--plugin="protoc-gen-ts=${PROTOC_GEN_TS_PATH}" \
		-I=pb \
		-I=${GOPATH}/src \
		--ts_out=service=grpc-web:ts \
		pb/node.proto
	# generate javascript bindings (node)
	protoc \
		-I=pb \
		-I=${GOPATH}/src \
		--js_out=import_style=commonjs,binary:js \
		--grpc_out=js \
		--plugin=protoc-gen-grpc=`which grpc_tools_node_protoc_plugin` \
		pb/node.proto
	# generate java bindings (node)
	protoc \
		-I=pb \
		-I=${GOPATH}/src \
		--plugin=protoc-gen-grpc-java=build/protoc-gen-grpc-java \
  		--grpc-java_out=java \
		pb/node.proto
    # generate rust bindings (node)
	protoc \
		-I=pb \
		-I=${GOPATH}/src \
		--rust_out=rs/src \
		--grpc_out=rs/src \
		--plugin=protoc-gen-grpc=`which grpc_rust_plugin` \
		pb/node.proto


gen-status:
	# generate golang bindings (status)
	protoc \
		-I=pb \
		-I=${GOPATH}/src \
		pb/status.proto \
		--gogofaster_out=plugins=grpc:go
	# generate python bindings (status)
	python3 -m grpc_tools.protoc \
		-I=pb \
		-I=${GOPATH}/src \
		pb/status.proto \
		--python_out=py \
		--grpc_python_out=py
	# generate typescript bindings (status)
	protoc \
		--plugin="protoc-gen-ts=${PROTOC_GEN_TS_PATH}" \
		-I=pb \
		-I=${GOPATH}/src \
		--ts_out=service=grpc-web:ts \
		pb/status.proto
	# generate javascript bindings (dag)
	protoc \
		-I=pb \
		-I=${GOPATH}/src \
		--js_out=import_style=commonjs,binary:js \
		--grpc_out=js \
		--plugin=protoc-gen-grpc=`which grpc_tools_node_protoc_plugin` \
		pb/status.proto
	# generate java bindings (status)
	protoc \
		-I=pb \
		-I=${GOPATH}/src \
		--plugin=protoc-gen-grpc-java=build/protoc-gen-grpc-java \
  		--grpc-java_out=java \
		pb/status.proto
    # generate rust bindings (status)
	protoc \
		-I=pb \
		-I=${GOPATH}/src \
		--rust_out=rs/src \
		--grpc_out=rs/src \
		--plugin=protoc-gen-grpc=`which grpc_rust_plugin` \
		pb/status.proto


gen-pubsub:
	# generate golang bindings (pubsub)
	protoc \
		-I=pb \
		-I=${GOPATH}/src \
		pb/pubsub.proto \
		--gogofaster_out=plugins=grpc:go
	# generate python bindings (pubsub)
	python3 -m grpc_tools.protoc \
		-I=pb \
		-I=${GOPATH}/src \
		pb/pubsub.proto \
		--python_out=py \
		--grpc_python_out=py
	# generate typescript bindings (pubsub)
	protoc \
		--plugin="protoc-gen-ts=${PROTOC_GEN_TS_PATH}" \
		-I=pb \
		-I=${GOPATH}/src \
		--ts_out=service=grpc-web:ts \
		pb/pubsub.proto
	# generate javascript bindings (pubsub)
	protoc \
		-I=pb \
		-I=${GOPATH}/src \
		--js_out=import_style=commonjs,binary:js \
		--grpc_out=js \
		--plugin=protoc-gen-grpc=`which grpc_tools_node_protoc_plugin` \
		pb/pubsub.proto
	# generate java bindings (pubsub)
	protoc \
		-I=pb \
		-I=${GOPATH}/src \
		--plugin=protoc-gen-grpc-java=build/protoc-gen-grpc-java \
  		--grpc-java_out=java \
		pb/pubsub.proto
    # generate rust bindings (pubsub)
	protoc \
		-I=pb \
		-I=${GOPATH}/src \
		--rust_out=rs/src \
		--grpc_out=rs/src \
		--plugin=protoc-gen-grpc=`which grpc_rust_plugin` \
		pb/pubsub.proto

gen-admin:
	# generate golang bindings (admin)
	protoc \
		-I=pb \
		-I=${GOPATH}/src \
		pb/admin.proto \
		--gogofaster_out=plugins=grpc:go
	# generate python bindings (admin)
	python3 -m grpc_tools.protoc \
		-I=pb \
		-I=${GOPATH}/src \
		pb/admin.proto \
		--python_out=py \
		--grpc_python_out=py
	# generate typescript bindings (admin)
	protoc \
		--plugin="protoc-gen-ts=${PROTOC_GEN_TS_PATH}" \
		-I=pb \
		-I=${GOPATH}/src \
		--ts_out=service=grpc-web:ts \
		pb/admin.proto
	# generate javascript bindings (dag)
	protoc \
		-I=pb \
		-I=${GOPATH}/src \
		--js_out=import_style=commonjs,binary:js \
		--grpc_out=js \
		--plugin=protoc-gen-grpc=`which grpc_tools_node_protoc_plugin` \
		pb/admin.proto
	# generate java bindings (admin)
	protoc \
		-I=pb \
		-I=${GOPATH}/src \
		--plugin=protoc-gen-grpc-java=build/protoc-gen-grpc-java \
  		--grpc-java_out=java \
		pb/admin.proto
    # generate rust bindings (admin)
	protoc \
		-I=pb \
		-I=${GOPATH}/src \
		--rust_out=rs/src \
		--grpc_out=rs/src \
		--plugin=protoc-gen-grpc=`which grpc_rust_plugin` \
		pb/admin.proto

gen-namesys:
	# generate golang bindings (namesys)
	protoc \
		-I=pb \
		-I=${GOPATH}/src \
		pb/namesys.proto \
		--gogofaster_out=plugins=grpc:go
	# generate python bindings (namesys)
	python3 -m grpc_tools.protoc \
		-I=pb \
		-I=${GOPATH}/src \
		pb/namesys.proto \
		--python_out=py \
		--grpc_python_out=py
	# generate typescript bindings (namesys)
	protoc \
		--plugin="protoc-gen-ts=${PROTOC_GEN_TS_PATH}" \
		-I=pb \
		-I=${GOPATH}/src \
		--ts_out=service=grpc-web:ts \
		pb/namesys.proto
	# generate javascript bindings (namesys)
	protoc \
		-I=pb \
		-I=${GOPATH}/src \
		--js_out=import_style=commonjs,binary:js \
		--plugin=protoc-gen-grpc=`which grpc_tools_node_protoc_plugin` \
		pb/namesys.proto
	# generate java bindings (namesys)
	protoc \
		-I=pb \
		-I=${GOPATH}/src \
		--plugin=protoc-gen-grpc-java=build/protoc-gen-grpc-java \
  		--grpc-java_out=java \
		pb/namesys.proto
    # generate rust bindings (namesys)
	protoc \
		-I=pb \
		-I=${GOPATH}/src \
		--rust_out=rs/src \
		--grpc_out=rs/src \
		--plugin=protoc-gen-grpc=`which grpc_rust_plugin` \
		pb/namesys.proto

gen-replication:
	# generate golang bindings (replication)
	protoc \
		-I=pb \
		-I=${GOPATH}/src \
		pb/replication.proto \
		--gogofast_out=plugins=grpc:go
	# generate python bindings (replication)
	python3 -m grpc_tools.protoc \
		-I=pb \
		-I=${GOPATH}/src \
		pb/replication.proto \
		--python_out=py \
		--grpc_python_out=py
	# generate typescript bindings (replication)
	protoc \
		--plugin="protoc-gen-ts=${PROTOC_GEN_TS_PATH}" \
		-I=pb \
		-I=${GOPATH}/src \
		--ts_out=service=grpc-web:ts \
		pb/replication.proto
	# generate javascript bindings (replication)
	protoc \
		-I=pb \
		-I=${GOPATH}/src \
		--js_out=import_style=commonjs,binary:js \
		--grpc_out=js \
		--plugin=protoc-gen-grpc=`which grpc_tools_node_protoc_plugin` \
		pb/replication.proto
	# generate java bindings (replication)
	protoc \
		-I=pb \
		-I=${GOPATH}/src \
		--plugin=protoc-gen-grpc-java=build/protoc-gen-grpc-java \
  		--grpc-java_out=java \
		pb/replication.proto
    # generate rust bindings (replication)
	protoc \
		-I=pb \
		-I=${GOPATH}/src \
		--rust_out=rs/src \
		--grpc_out=rs/src \
		--plugin=protoc-gen-grpc=`which grpc_rust_plugin` \
		pb/replication.proto

gen-docs:
		# generate documentation
	protoc \
		-I=pb \
		--doc_out=doc \
		--doc_opt=markdown,PROTO.md \
		pb/*.proto