@aptre/common 0.24.0 → 0.26.2

package/.gitignore

@@ -1,4 +1,5 @@
 /node_modules
+.protoc-manifest.json
 /coverage
 /build
 /.log
@@ -24,3 +25,4 @@ debug.test*
 .vscode/
 !.vscode/launch.json
 /vendor/
+.opencode/tool-output

package/README.md

@@ -1,21 +1,39 @@
-## Common
+# common
 
-This contains common files like the project Makefile.
+[![GoDoc Widget]][GoDoc] [![Go Report Card Widget]][Go Report Card] [![npm Widget]][npm]
 
-See [template] for a project template that uses this package.
+> Common build tools and utilities for Aperture Robotics Go projects.
 
-[template]: https://github.com/aperturerobotics/template
+[GoDoc]: https://godoc.org/github.com/aperturerobotics/common
+[GoDoc Widget]: https://godoc.org/github.com/aperturerobotics/common?status.svg
+[Go Report Card Widget]: https://goreportcard.com/badge/github.com/aperturerobotics/common
+[Go Report Card]: https://goreportcard.com/report/github.com/aperturerobotics/common
+[npm]: https://www.npmjs.com/package/@aptre/common
+[npm Widget]: https://img.shields.io/npm/v/@aptre/common.svg
 
-See [protobuf-project] for a more extensive example.
+## Related Projects
 
-[protobuf-project]: https://github.com/aperturerobotics/protobuf-project
+- [template](https://github.com/aperturerobotics/template) - Project template using this package
+- [protobuf-project](https://github.com/aperturerobotics/protobuf-project) - More extensive example
+
+## Installation
+
+The `aptre` CLI tool replaces Make for building Go projects with protobuf support.
+
+```bash
+# Run directly
+go run github.com/aperturerobotics/common/cmd/aptre@latest <command>
+
+# Or install globally
+go install github.com/aperturerobotics/common/cmd/aptre@latest
+```
 
 ## Usage
 
 Start by downloading the dependencies:
 
 ```bash
-yarn
+bun i
 ```
 
 Protobuf imports use Go paths and package names:
@@ -37,63 +55,84 @@ message GetBusInfoResponse {
 To generate the protobuf files:
 
 ```bash
-$ git add -A
-$ yarn gen
+git add -A
+go run ./cmd/aptre generate
+# or with bun
+bun run gen
 ```
 
-The Makefile will download the tools using Go to a bin dir.
-
-## Makefile
-
-The available make targets are:
-
- - `gen`: Generate protobuf files.
- - `test`: Run go tests. 
- - `test-browser`: Run go tests in a web browser with WebAssembly.
- - `lint`: Run golangci-lint on the project.
- - `fix`: Run golangci-lint with --fix on the project.
- - `format`: Format Go and TypeScript code.
- - `release`: Create a new release using goreleaser.
- - `release-bundle`: Create a bundled snapshot release using goreleaser. 
- - `release-build`: Build a snapshot release using goreleaser.
- - `release-check`: Run goreleaser checks.
+## Commands
+
+The `aptre` CLI provides the following commands:
+
+| Command          | Description                                  |
+| ---------------- | -------------------------------------------- |
+| `generate`       | Generate protobuf code (Go, TypeScript, C++) |
+| `clean`          | Remove generated files and cache             |
+| `deps`           | Ensure all dependencies are installed        |
+| `lint`           | Run golangci-lint                            |
+| `fix`            | Run golangci-lint with --fix                 |
+| `test`           | Run go test                                  |
+| `test --browser` | Run tests in browser with WebAssembly        |
+| `format`         | Format Go code with gofumpt                  |
+| `goimports`      | Run goimports                                |
+| `outdated`       | Show outdated dependencies                   |
+| `release run`    | Create a release using goreleaser            |
+| `release bundle` | Create a bundled snapshot release            |
+| `release build`  | Build a snapshot release                     |
+| `release check`  | Run goreleaser checks                        |
+
+### Examples
 
-To generate the TypeScript and Go code:
+```bash
+# Generate protobuf files
+go run ./cmd/aptre generate
 
- - `yarn gen`
+# Force regeneration (ignore cache)
+go run ./cmd/aptre generate --force
 
-To format the Go and TypeScript files:
+# Run tests
+go run ./cmd/aptre test
 
- - `yarn format`
+# Run browser/WASM tests
+go run ./cmd/aptre test --browser
 
-## Eject
+# Lint code
+go run ./cmd/aptre lint
 
-You can "eject" and copy all the project files directly to your repo:
+# Format code
+go run ./cmd/aptre format
 
-```
-# NOTE: not a full list of files
-cp ./vendor/github.com/aperturerobotics/common/{Makefile,.eslintrc.js,.eslintignore} ./
+# Check for outdated dependencies
+go run ./cmd/aptre outdated
 ```
 
-While not implemented yet, "make eject" will do this for you.
+## C++ Support
 
-## Developing on MacOS
+C++ protobuf files (`.pb.cc` and `.pb.h`) are generated alongside the `.pb.go`
+files. Add `vendor/` to your include path and create a symlink for your project:
 
-On MacOS, some homebrew packages are required for `yarn gen`:
+```cmake
+# CMakeLists.txt
+set(VENDOR_LINK_DIR "${CMAKE_CURRENT_SOURCE_DIR}/vendor/github.com/yourorg")
+if(NOT EXISTS "${VENDOR_LINK_DIR}/yourproject")
+    file(CREATE_LINK "${CMAKE_CURRENT_SOURCE_DIR}" "${VENDOR_LINK_DIR}/yourproject" SYMBOLIC)
+endif()
 
+include_directories(${PROJECT_SOURCE_DIR}/vendor)
 ```
-brew install bash make coreutils gnu-sed findutils protobuf
-brew link --overwrite protobuf
+
+```cpp
+#include "github.com/yourorg/yourproject/example/example.pb.h"
 ```
 
-Add to your .bashrc or .zshrc:
+## Embedded Protoc
 
-```
-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"
-```
+The `aptre` tool uses an embedded WebAssembly version of protoc via [go-protoc-wasi].
+This means you don't need to install protoc separately - it works on any platform
+that supports Go.
+
+[go-protoc-wasi]: https://github.com/aperturerobotics/go-protoc-wasi
 
 ## Support
 
@@ -103,8 +142,8 @@ Please open a [GitHub issue] with any questions / issues.
 
 ... or feel free to reach out on [Matrix Chat] or [Discord].
 
-[Discord]: https://discord.gg/KJutMESRsT
 [Matrix Chat]: https://matrix.to/#/#aperturerobotics:matrix.org
+[Discord]: https://discord.gg/KJutMESRsT
 
 ## License
 

package/go.mod

@@ -7,6 +7,17 @@ replace github.com/libp2p/go-libp2p => github.com/aperturerobotics/go-libp2p v0.
 
 replace github.com/ipfs/go-log/v2 => github.com/paralin/ipfs-go-logrus v0.0.0-20240410105224-e24cb05f9e98 // master
 
-require github.com/aperturerobotics/protobuf-go-lite v0.11.0 // latest
+require (
+	github.com/aperturerobotics/abseil-cpp v0.0.0-20260130220554-305ed0ea7006
+	github.com/aperturerobotics/cli v1.1.0
+	github.com/aperturerobotics/go-protoc-wasi v0.0.0-20260131033208-273d2014699f
+	github.com/aperturerobotics/protobuf v0.0.0-20260131031545-7265127e58f9
+	github.com/aperturerobotics/protobuf-go-lite v0.12.0 // latest
+	github.com/tetratelabs/wazero v1.8.2
+	golang.org/x/mod v0.22.0
+)
 
-require github.com/aperturerobotics/json-iterator-lite v1.0.1-0.20240713111131-be6bf89c3008 // indirect
+require (
+	github.com/aperturerobotics/json-iterator-lite v1.0.1-0.20240713111131-be6bf89c3008 // indirect
+	github.com/xrash/smetrics v0.0.0-20250705151800-55b8f293f342 // indirect
+)