Comments (4)
2 seems to be a problem as protoc is usually installed globally. A server developed on the same machine may require a newer version.
1 is nice, as it serves as a bit of a unit test against unwanted regressions, but I assume most changes to the code would cause output to differ, and CI tests that fail always are a bit annoying.
You could also add the version to Contributing.md and manually note unwarranted changes to the generated output when reviewing PRs
from ts-protoc-gen.
Oh yes, both of these are flawed, probably not a great idea to respond to GitHub issues at 7am 😂
You're right, updating the contribution guide is an obvious first step, however another spin on option #2 may be to download protoc as part of generate.sh as it is a standalone binary
from ts-protoc-gen.
I'm leaning towards a pinned version of protoc for the repository. This makes the experience consistent for all contributors. Furthermore, an upgrade is only a PR away which helps us track the protoc target we're building against.
I can see three ways to get this done:
- Docker container with
protoc
- Use grpc-tools which bundles
protoc
but hasn't been updated in a while - Use Bazel to generate the examples. This would require contributors to install bazel.
I like 1 and 3 or going with downloading protoc
from ts-protoc-gen.
Ah yes, sorry about that. I think we need to enforce a given version of protoc for consistency. Two options I see are:
-
Add a CI build step which regenerates the example protos and then checks for changes, if there are any it will fail the CI build with a descriptive error message
-
Add a local build step which checks the users locally installed version of or protoc.
However I'm welcome to other suggestions 😀
from ts-protoc-gen.
Related Issues (20)
- d.ts files not generated HOT 4
- setXX() method return type is wrong in .d.ts file HOT 1
- proto3 - required / optional fields HOT 4
- Could we support friendlier object-literal syntax for service methods? HOT 1
- Fix TypeScript annotations for setters HOT 4
- Error: 13 INTERNAL: Request message serialization failure: Expected argument of type xxx HOT 3
- OnHeaders callback is not accessible. HOT 2
- How to deal with extensions? HOT 1
- Bad TS types for proto3 optional fields HOT 1
- Generate grpc-web code that use import than require HOT 5
- Error of protoc compiles FieldOption when using a enum from other proto
- Why is there no off() method on ResponseStream ?
- Does it support generating ES6 specification JS files and using them in grPC-Web
- protobuf v21 can't find protoc-gen-js HOT 3
- Module not found error while importing from _pb.d.ts file
- Getting the string name of Protobuf object
- Trailing underscore, toObject produces object that does not conform to AsObject
- The proper user code
- no set method TS types for proto3 Map field
- Typing for repeated extension fields generated incorrectly
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from ts-protoc-gen.