@aptre/common 0.12.6

package/.eslintrc.js

@@ -0,0 +1,28 @@
+module.exports = {
+  root: true,
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint', 'unused-imports'],
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:react-hooks/recommended',
+    'prettier',
+  ],
+  parserOptions: {
+    project: './tsconfig.json',
+  },
+  rules: {
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-non-null-assertion': 'off',
+  },
+  ignorePatterns: [
+    "node_modules",
+    "dist",
+    "coverage",
+    "bundle",
+    "runtime",
+    "vendor",
+    ".eslintrc.js",
+    "wasm_exec.js"
+  ]
+}

package/.gitignore

@@ -0,0 +1,26 @@
+/node_modules
+/coverage
+/build
+/.log
+/.tools
+/.aider*
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+.#*
+debug.test*
+/dist
+.*.swp
+.vs/
+.vscode/
+!.vscode/launch.json
+/vendor/

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2022 Aperture Robotics, LLC. <christian@aperture.us>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/Makefile

@@ -0,0 +1,193 @@
+# https://github.com/aperturerobotics/template
+
+# Projects can override PROJECT_DIR with the path to their project.
+COMMON_DIR = $(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))
+PROJECT_DIR := $(COMMON_DIR)
+PROJECT_DIR_REL = $(shell realpath --relative-to $(COMMON_DIR) $(PROJECT_DIR))
+
+TOOLS_DIR := .tools
+TOOLS_BIN := $(TOOLS_DIR)/bin
+PROJECT_TOOLS_DIR := $(PROJECT_DIR)/.tools
+PROJECT_TOOLS_DIR_REL = $(shell realpath --relative-to $(COMMON_DIR) $(PROJECT_TOOLS_DIR))
+
+SHELL:=bash
+MAKEFLAGS += --no-print-directory
+
+export GO111MODULE=on
+undefine GOARCH
+undefine GOOS
+
+.PHONY: all
+all: protodeps
+
+# Setup node_modules
+$(PROJECT_DIR)/node_modules:
+	cd $(PROJECT_DIR_REL); yarn install
+
+# Setup the .tools directory to hold the build tools in the project repo
+$(PROJECT_TOOLS_DIR):
+	@cd $(PROJECT_DIR); go run -v github.com/aperturerobotics/common $(TOOLS_DIR)
+
+# Build tool rule
+define build_tool
+$(PROJECT_DIR)/$(1): $(PROJECT_TOOLS_DIR)
+	cd $(PROJECT_TOOLS_DIR_REL); \
+	go build -mod=readonly -v \
+		-o ./bin/$(shell basename $(1)) \
+		$(2)
+
+.PHONY: $(1)
+$(1): $(PROJECT_DIR)/$(1)
+endef
+
+# List of available Go tool binaries
+PROTOWRAP=$(TOOLS_BIN)/protowrap
+PROTOC_GEN_GO=$(TOOLS_BIN)/protoc-gen-go-lite
+PROTOC_GEN_GO_STARPC=$(TOOLS_BIN)/protoc-gen-go-starpc
+GOIMPORTS=$(TOOLS_BIN)/goimports
+GOFUMPT=$(TOOLS_BIN)/gofumpt
+GOLANGCI_LINT=$(TOOLS_BIN)/golangci-lint
+GO_MOD_OUTDATED=$(TOOLS_BIN)/go-mod-outdated
+GORELEASER=$(TOOLS_BIN)/goreleaser
+
+# Mappings for build tool to Go import path
+$(eval $(call build_tool,$(PROTOC_GEN_GO),github.com/aperturerobotics/protobuf-go-lite/cmd/protoc-gen-go-lite))
+$(eval $(call build_tool,$(PROTOC_GEN_GO_STARPC),github.com/aperturerobotics/starpc/cmd/protoc-gen-go-starpc))
+$(eval $(call build_tool,$(GOIMPORTS),golang.org/x/tools/cmd/goimports))
+$(eval $(call build_tool,$(GOFUMPT),mvdan.cc/gofumpt))
+$(eval $(call build_tool,$(PROTOWRAP),github.com/aperturerobotics/goprotowrap/cmd/protowrap))
+$(eval $(call build_tool,$(GOLANGCI_LINT),github.com/golangci/golangci-lint/cmd/golangci-lint))
+$(eval $(call build_tool,$(GO_MOD_OUTDATED),github.com/psampaz/go-mod-outdated))
+$(eval $(call build_tool,$(GORELEASER),github.com/goreleaser/goreleaser))
+
+.PHONY: protodeps
+protodeps: $(GOIMPORTS) $(PROTOWRAP) $(PROTOC_GEN_GO) $(PROTOC_GEN_GO_STARPC) $(PROJECT_DIR)/node_modules
+
+# Default protogen targets and arguments
+PROTOGEN_TARGETS ?= ./*.proto
+PROTOGEN_ARGS ?=
+GO_LITE_OPT_FEATURES ?= marshal+unmarshal+size+equal+json+clone+text
+
+.PHONY: genproto
+genproto: protodeps
+	@shopt -s globstar; \
+	set -eo pipefail; \
+	cd $(PROJECT_DIR); \
+	export PROJECT=$$(go list -m); \
+	export OUT=./vendor; \
+	mkdir -p $${OUT}/$$(dirname $${PROJECT}); \
+	rm -f ./vendor/$${PROJECT}; \
+	ln -s $$(pwd) ./vendor/$${PROJECT}; \
+	protogen() { \
+		PROTO_FILES=$$(git ls-files "$$1"); \
+		FMT_GO_FILES=(); \
+		FMT_TS_FILES=(); \
+		$(PROTOWRAP) \
+			-I $${OUT} \
+			--plugin=$(PROTOC_GEN_GO) \
+			--plugin=$(PROTOC_GEN_GO_STARPC) \
+			--plugin=./node_modules/.bin/protoc-gen-es \
+			--plugin=./node_modules/.bin/protoc-gen-es-starpc \
+			--go-lite_out=$${OUT} \
+			--go-lite_opt=features=$(GO_LITE_OPT_FEATURES) \
+			--go-starpc_out=$${OUT} \
+			--es_out=$${OUT} \
+			--es_opt target=ts \
+			--es_opt ts_nocheck=false \
+			--es-starpc_out=$${OUT} \
+			--es-starpc_opt target=ts \
+			--es-starpc_opt ts_nocheck=false \
+			--proto_path $${OUT} \
+			--print_structure \
+			--only_specified_files \
+			$(PROTOGEN_ARGS) \
+			$$(echo "$$PROTO_FILES" | xargs printf -- "./vendor/$${PROJECT}/%s "); \
+		for proto_file in $${PROTO_FILES}; do \
+			proto_dir=$$(dirname $$proto_file); \
+			proto_name=$${proto_file%".proto"}; \
+			GO_FILES=$$(git ls-files ":(glob)$${proto_dir}/${proto_name}*.pb.go"); \
+			if [ -n "$$GO_FILES" ]; then FMT_GO_FILES+=($${GO_FILES[@]}); fi; \
+			TS_FILES=$$(git ls-files ":(glob)$${proto_dir}/${proto_name}*_*pb.ts"); \
+			if [ -n "$$TS_FILES" ]; then FMT_TS_FILES+=($${TS_FILES[@]}); fi; \
+			if [ -z "$$TS_FILES" ]; then continue; fi; \
+			for ts_file in $${TS_FILES}; do \
+				ts_file_dir=$$(dirname $$ts_file); \
+				relative_path=$${ts_file_dir#"./"}; \
+				depth=$$(echo $$relative_path | awk -F/ '{print NF+1}'); \
+				prefix=$$(printf '../%0.s' $$(seq 1 $$depth)); \
+				istmts=$$(grep -oE "from\s+\"$$prefix[^\"]+\"" $$ts_file) || continue; \
+				if [ -z "$$istmts" ]; then continue; fi; \
+				ipaths=$$(echo "$$istmts" | awk -F'"' '{print $$2}'); \
+				for import_path in $$ipaths; do \
+					rel_import_path=$$(realpath -s --relative-to=./vendor \
+						"./vendor/$${PROJECT}/$${ts_file_dir}/$${import_path}"); \
+					go_import_path=$$(echo $$rel_import_path | sed -e "s|^|@go/|"); \
+					sed -i -e "s|$$import_path|$$go_import_path|g" $$ts_file; \
+				done; \
+			done; \
+		done; \
+		if [ -n "$${FMT_GO_FILES}" ]; then \
+			$(GOIMPORTS) -w $${FMT_GO_FILES[@]}; \
+		fi; \
+		if [ -n "$${FMT_TS_FILES}" ]; then \
+			prettier --config $(TOOLS_DIR)/.prettierrc.yaml -w $${FMT_TS_FILES[@]}; \
+		fi; \
+	}; \
+	protogen "$(PROTOGEN_TARGETS)"; \
+	rm -f ./vendor/$${PROJECT}
+
+.PHONY: gen
+gen: genproto
+
+.PHONY: outdated
+outdated: $(GO_MOD_OUTDATED)
+	cd $(PROJECT_DIR); \
+	go list -mod=mod -u -m -json all | $(GO_MOD_OUTDATED) -update -direct
+
+.PHONY: list
+list: $(GO_MOD_OUTDATED)
+	cd $(PROJECT_DIR); \
+	go list -mod=mod -u -m -json all | $(GO_MOD_OUTDATED)
+
+.PHONY: lint
+lint: $(GOLANGCI_LINT)
+	cd $(PROJECT_DIR); \
+	$(GOLANGCI_LINT) run
+
+.PHONY: fix
+fix: $(GOLANGCI_LINT)
+	cd $(PROJECT_DIR); \
+	$(GOLANGCI_LINT) run --fix
+
+.PHONY: test
+test:
+	cd $(PROJECT_DIR); \
+	go test -v ./...
+
+.PHONY: format
+format: $(GOFUMPT) $(GOIMPORTS)
+	cd $(PROJECT_DIR); \
+	$(GOIMPORTS) -w ./; \
+	$(GOFUMPT) -w ./
+
+.PHONY: release
+release: $(GORELEASER)
+	cd $(PROJECT_DIR); \
+	$(GORELEASER) release $(GORELEASER_OPTS)
+
+.PHONY: release-bundl\e
+release-bundle: $(GORELEASER)
+	cd $(PROJECT_DIR); \
+	$(GORELEASER) check; \
+	$(GORELEASER) release --snapshot --clean --skip-publish $(GORELEASER_OPTS)
+
+.PHONY: release-build
+release-build: $(GORELEASER)
+	cd $(PROJECT_DIR); \
+	$(GORELEASER) check; \
+	$(GORELEASER) build --single-target --snapshot --clean $(GORELEASER_OPTS)
+
+.PHONY: release-check
+release-check: $(GORELEASER)
+	cd $(PROJECT_DIR); \
+	$(GORELEASER) check

package/README.md

@@ -0,0 +1,107 @@
+## Common
+
+This contains common files like the project Makefile.
+
+See [template] for a project template that uses this package.
+
+[template]: https://github.com/aperturerobotics/template
+
+See [protobuf-project] for a more extensive example.
+
+[protobuf-project]: https://github.com/aperturerobotics/protobuf-project
+
+## Usage
+
+Start by downloading the dependencies:
+
+```bash
+yarn
+```
+
+Protobuf imports use Go paths and package names:
+
+```protobuf
+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:
+
+```bash
+$ git add -A
+$ yarn gen
+```
+
+The Makefile will download the tools using Go to a bin dir.
+
+## Makefile
+
+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 dependencies
+ - `outdated`: list outdated go module dependencies
+
+To generate the TypeScript and Go code:
+
+ - `yarn gen`
+
+To format the Go and TypeScript files:
+
+ - `yarn format`
+
+## Eject
+
+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.
+
+## Developing on MacOS
+
+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"
+```
+
+## Support
+
+Please open a [GitHub issue] with any questions / issues.
+
+[GitHub issue]: https://github.com/aperturerobotics/common/issues/new
+
+... or feel free to reach out on [Matrix Chat] or [Discord].
+
+[Discord]: https://discord.gg/KJutMESRsT
+[Matrix Chat]: https://matrix.to/#/#aperturerobotics:matrix.org
+
+## License
+
+MIT

package/deps.go.tools

@@ -0,0 +1,29 @@
+//go:build deps_only
+// +build deps_only
+
+package hack
+
+import (
+
+	// _ imports protowrap
+	_ "github.com/aperturerobotics/goprotowrap/cmd/protowrap"
+	// _ imports protoc-gen-go-lite
+	_ "github.com/aperturerobotics/protobuf-go-lite/cmd/protoc-gen-go-lite"
+	// _ imports protoc-gen-starpc
+	_ "github.com/aperturerobotics/starpc/cmd/protoc-gen-go-starpc"
+
+	// _ imports golangci-lint
+	_ "github.com/golangci/golangci-lint/pkg/golinters"
+	// _ imports golangci-lint commands
+	_ "github.com/golangci/golangci-lint/pkg/commands"
+
+	// _ imports go-mod-outdated
+	_ "github.com/psampaz/go-mod-outdated"
+	// _ imports goimports
+	_ "golang.org/x/tools/cmd/goimports"
+	// _ imports gofumpt
+	_ "mvdan.cc/gofumpt"
+
+	// _ imports goreleaser
+	_ "github.com/goreleaser/goreleaser"
+)

package/dist/common.js

@@ -0,0 +1 @@
+"use strict";

package/dist/example/example_pb.d.ts

@@ -0,0 +1,30 @@
+import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialMessage, PlainMessage } from '@bufbuild/protobuf';
+import { Message, proto3 } from '@bufbuild/protobuf';
+import { OtherMsg } from './other/other_pb.js';
+/**
+ * ExampleMsg is an example message.
+ *
+ * @generated from message example.ExampleMsg
+ */
+export declare class ExampleMsg extends Message<ExampleMsg> {
+    /**
+     * ExampleField is an example field.
+     *
+     * @generated from field: string example_field = 1;
+     */
+    exampleField: string;
+    /**
+     * OtherMsg is an example of an imported message field.
+     *
+     * @generated from field: example.other.OtherMsg other_msg = 2;
+     */
+    otherMsg?: OtherMsg;
+    constructor(data?: PartialMessage<ExampleMsg>);
+    static readonly runtime: typeof proto3;
+    static readonly typeName = "example.ExampleMsg";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): ExampleMsg;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): ExampleMsg;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): ExampleMsg;
+    static equals(a: ExampleMsg | PlainMessage<ExampleMsg> | undefined, b: ExampleMsg | PlainMessage<ExampleMsg> | undefined): boolean;
+}

package/dist/example/example_pb.js

@@ -0,0 +1,51 @@
+// @generated by protoc-gen-es v1.9.0 with parameter "target=ts,ts_nocheck=false"
+// @generated from file github.com/aperturerobotics/common/example/example.proto (package example, syntax proto3)
+/* eslint-disable */
+import { Message, proto3 } from '@bufbuild/protobuf';
+import { OtherMsg } from './other/other_pb.js';
+/**
+ * ExampleMsg is an example message.
+ *
+ * @generated from message example.ExampleMsg
+ */
+export class ExampleMsg extends Message {
+    /**
+     * ExampleField is an example field.
+     *
+     * @generated from field: string example_field = 1;
+     */
+    exampleField = '';
+    /**
+     * OtherMsg is an example of an imported message field.
+     *
+     * @generated from field: example.other.OtherMsg other_msg = 2;
+     */
+    otherMsg;
+    constructor(data) {
+        super();
+        proto3.util.initPartial(data, this);
+    }
+    static runtime = proto3;
+    static typeName = 'example.ExampleMsg';
+    static fields = proto3.util.newFieldList(() => [
+        {
+            no: 1,
+            name: 'example_field',
+            kind: 'scalar',
+            T: 9 /* ScalarType.STRING */,
+        },
+        { no: 2, name: 'other_msg', kind: 'message', T: OtherMsg },
+    ]);
+    static fromBinary(bytes, options) {
+        return new ExampleMsg().fromBinary(bytes, options);
+    }
+    static fromJson(jsonValue, options) {
+        return new ExampleMsg().fromJson(jsonValue, options);
+    }
+    static fromJsonString(jsonString, options) {
+        return new ExampleMsg().fromJsonString(jsonString, options);
+    }
+    static equals(a, b) {
+        return proto3.util.equals(ExampleMsg, a, b);
+    }
+}

package/dist/example/other/other_pb.d.ts

@@ -0,0 +1,23 @@
+import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialMessage, PlainMessage } from '@bufbuild/protobuf';
+import { Message, proto3 } from '@bufbuild/protobuf';
+/**
+ * OtherMsg is a different message from ExampleMsg.
+ *
+ * @generated from message example.other.OtherMsg
+ */
+export declare class OtherMsg extends Message<OtherMsg> {
+    /**
+     * FooField is an example field.
+     *
+     * @generated from field: uint32 foo_field = 1;
+     */
+    fooField: number;
+    constructor(data?: PartialMessage<OtherMsg>);
+    static readonly runtime: typeof proto3;
+    static readonly typeName = "example.other.OtherMsg";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): OtherMsg;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): OtherMsg;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): OtherMsg;
+    static equals(a: OtherMsg | PlainMessage<OtherMsg> | undefined, b: OtherMsg | PlainMessage<OtherMsg> | undefined): boolean;
+}

package/dist/example/other/other_pb.js

@@ -0,0 +1,38 @@
+// @generated by protoc-gen-es v1.9.0 with parameter "target=ts,ts_nocheck=false"
+// @generated from file github.com/aperturerobotics/common/example/other/other.proto (package example.other, syntax proto3)
+/* eslint-disable */
+import { Message, proto3 } from '@bufbuild/protobuf';
+/**
+ * OtherMsg is a different message from ExampleMsg.
+ *
+ * @generated from message example.other.OtherMsg
+ */
+export class OtherMsg extends Message {
+    /**
+     * FooField is an example field.
+     *
+     * @generated from field: uint32 foo_field = 1;
+     */
+    fooField = 0;
+    constructor(data) {
+        super();
+        proto3.util.initPartial(data, this);
+    }
+    static runtime = proto3;
+    static typeName = 'example.other.OtherMsg';
+    static fields = proto3.util.newFieldList(() => [
+        { no: 1, name: 'foo_field', kind: 'scalar', T: 13 /* ScalarType.UINT32 */ },
+    ]);
+    static fromBinary(bytes, options) {
+        return new OtherMsg().fromBinary(bytes, options);
+    }
+    static fromJson(jsonValue, options) {
+        return new OtherMsg().fromJson(jsonValue, options);
+    }
+    static fromJsonString(jsonString, options) {
+        return new OtherMsg().fromJsonString(jsonString, options);
+    }
+    static equals(a, b) {
+        return proto3.util.equals(OtherMsg, a, b);
+    }
+}

package/go.mod

@@ -0,0 +1,16 @@
+module github.com/aperturerobotics/common
+
+go 1.22
+
+toolchain go1.22.2
+
+require (
+	github.com/aperturerobotics/protobuf-go-lite v0.5.0 // latest
+	github.com/pkg/errors v0.9.1
+)
+
+require (
+	github.com/json-iterator/go v1.1.12 // indirect
+	github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421 // indirect
+	github.com/modern-go/reflect2 v1.0.2 // indirect
+)