feat: add protoc-gen-ts-client TypeScript HTTP client generator #104
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…rator Go-based protoc plugin that generates standalone TypeScript HTTP clients from protobuf service definitions. Uses native fetch, plain TS interfaces, JSON-only serialization, and idiomatic TypeScript patterns (options objects, async/await, AbortSignal). Co-Authored-By: Claude Opus 4.5 <[email protected]>
Three test cases using symlinked proto files shared with httpgen/clientgen: - http_verbs_comprehensive: all HTTP verbs, path/query params, headers - query_params: scalar types, custom names, mixed path+query - backward_compat: services without annotations, base-path-only Co-Authored-By: Claude Opus 4.5 <[email protected]>
Query param zero-value checks like `req.limit !== 0` pass when the field is undefined, causing "undefined" to be sent as a string value. Add `!= null` guard before each zero-value check so omitted fields are correctly skipped. Co-Authored-By: Claude Opus 4.5 <[email protected]>
End-to-end example showing protoc-gen-ts-client with a NoteService CRUD API. Includes Go server, TypeScript client exercising all endpoints (GET/POST/PUT/DELETE), query parameters, service/method headers, and error handling. Makefile handles the full workflow: build plugins, generate code, install deps, and run demo. Co-Authored-By: Claude Opus 4.5 <[email protected]>
Update README, CLAUDE.md, architecture, getting-started, client-generation, examples, contributing, and CI/CD docs to document the new TypeScript HTTP client generator plugin. Co-Authored-By: Claude Opus 4.5 <[email protected]>
SebastienMelki
requested review from
Elih96,
JoesHage,
elzalem and
hasanMshawrab
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## main #104 +/- ##
========================================
- Coverage 6.69% 5.91% -0.78%
========================================
Files 15 19 +4
Lines 4170 4720 +550
========================================
Hits 279 279
- Misses 3886 4436 +550
Partials 5 5
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
🔍 CI Pipeline Status✅ Lint: success 📊 Coverage Report: Available in checks above |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
protoc-gen-ts-client, a new protoc plugin that generates TypeScript HTTP clients from protobuf service definitionsValidationError/ApiError)undefinedfields were sent as the string"undefined"(added null guard before zero-value checks)ts-client-demoexample with a NoteService CRUD API (Go server + TypeScript client)Commits
feat(ts-client): add protoc-gen-ts-client TypeScript HTTP client generator— core plugin: generator, type mapping, annotations, helperstest(ts-client): add golden file tests for TypeScript client generation— golden tests for query params, HTTP verbs, backward compatfix(ts-client): guard query params against undefined/null values— null-safe zero-value checks in generated query param codefeat(ts-client): add TypeScript client demo example— NoteService CRUD demo with Go server and TS clientdocs: add protoc-gen-ts-client to all project docs— 8 documentation files updatedTest plan
go test ./internal/tsclientgen/— all golden file tests passcd examples/ts-client-demo && make demo— full end-to-end demo works (create, list, get, update, delete, query params, error handling)🤖 Generated with Claude Code