docs: record Node codegen prerequisite

This commit is contained in:
2026-08-11 19:18:55 +08:00
parent 01ab8399bb
commit e71dfd0c0e
@@ -6,7 +6,7 @@
**Architecture:** `proto` remains the only source of the protobuf contract. The two SDK repositories commit generated artifacts: Go stubs in the Go module root, and both ESM/Connect and CommonJS/gRPC outputs in separate Node subdirectories. Services consume tagged Gitea dependencies; existing local generation scripts and Dockerfiles remain unchanged. **Architecture:** `proto` remains the only source of the protobuf contract. The two SDK repositories commit generated artifacts: Go stubs in the Go module root, and both ESM/Connect and CommonJS/gRPC outputs in separate Node subdirectories. Services consume tagged Gitea dependencies; existing local generation scripts and Dockerfiles remain unchanged.
**Tech Stack:** Protobuf, Buf 1.72.0, `protoc-gen-go` 1.36.12, `protoc-gen-go-grpc` 1.6.2, `protoc-gen-es`, `protoc-gen-connect-es`, `grpc-tools`, Go modules, npm Git dependencies, Gitea Git over SSH. **Tech Stack:** Protobuf, Buf 1.72.0, `protoc-gen-go` 1.36.12, `protoc-gen-go-grpc` 1.6.2, `protoc-gen-es`, `protoc-gen-connect-es`, `grpc-tools` 1.13.1, `protoc-gen-js` 3.21.4-4, Go modules, npm Git dependencies, Gitea Git over SSH.
## Global Constraints ## Global Constraints
@@ -272,6 +272,7 @@ esm/yoresee_doc/v1/yoresee_doc_connect.js
Run from `yoresee_doc_sdk_node/`: Run from `yoresee_doc_sdk_node/`:
```bash ```bash
npm install -g protoc-gen-js@3.21.4-4
mkdir -p cjs mkdir -p cjs
grpc_tools_node_protoc -I ../yoresee_doc/proto \ grpc_tools_node_protoc -I ../yoresee_doc/proto \
--plugin=protoc-gen-grpc="$(command -v grpc_tools_node_protoc_plugin)" \ --plugin=protoc-gen-grpc="$(command -v grpc_tools_node_protoc_plugin)" \