This contains common files like the project Makefile.
See template for a project template that uses this package.
See protobuf-project for a more extensive example.
Start by downloading the dependencies:
yarnProtobuf imports use Go paths and package names:
syntax = "proto3";
package example;
// Import .proto files using Go-style import paths.
import "github.com/aperturerobotics/controllerbus/controller/controller.proto";
// GetBusInfoResponse is the response type for GetBusInfo.
message GetBusInfoResponse {
// RunningControllers is the list of running controllers.
repeated controller.Info running_controllers = 1;
}To generate the protobuf files:
$ git add -A
$ yarn genThe Makefile will download the tools using Go to a bin dir.
The available make targets are:
genproto: Generate protobuf files.test: run go test -v ./...lint: run golangci-lint on the project.fix: run golangci-lint --fix on the project.list: list go module dependenciesoutdated: list outdated go module dependencies
To generate the TypeScript and Go code:
yarn gen
To format the Go and TypeScript files:
yarn format
You can "eject" and copy all the project files directly to your repo:
# NOTE: not a full list of files
cp ./vendor/github.com/aperturerobotics/common/{Makefile,.eslintrc.js,.eslintignore} ./
While not implemented yet, "make eject" will do this for you.
On MacOS, some homebrew packages are required for yarn gen:
brew install bash make coreutils gnu-sed findutils protobuf
brew link --overwrite protobuf
Add to your .bashrc or .zshrc:
export PATH="/opt/homebrew/opt/coreutils/libexec/gnubin:$PATH"
export PATH="/opt/homebrew/opt/gnu-sed/libexec/gnubin:$PATH"
export PATH="/opt/homebrew/opt/findutils/libexec/gnubin:$PATH"
export PATH="/opt/homebrew/opt/make/libexec/gnubin:$PATH"
Please open a GitHub issue with any questions / issues.
... or feel free to reach out on Matrix Chat or Discord.
MIT