Generalize npm dependency support for generated js code
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 32/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- cpp, javascript
- Domain
- compilers
Research direction
Start by comparing javascript/net/grpc/web/grpc_generator.cc around the referenced import-path logic with protobuf's src/google/protobuf/compiler/js/js_generator.cc. Determine the import option and package-path behavior needed to generalize the current google-protobuf exception. Done means generated imports can explicitly resolve dependencies from user-specified npm packages while preserving relative imports where no override is provided.
Written by the indexing model from the issue text.
Description
Sister issue of https://github.com/grpc/grpc-web/issues/584 (copying content)
All generated code currently generates js import paths with similar structure with that of the imported .proto files.
The one exception for protobuf well-known types - google-protobuf based ont he import prefix:
https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/compiler/js/js_generator.cc#L128
string GetRootPath(const std::string& from_filename,
const std::string& to_filename) {
if (to_filename.find("google/protobuf") == 0) {
// Well-known types (.proto files in the google/protobuf directory) are
// assumed to come from the 'google-protobuf' npm package. We may want to
// generalize this exception later by letting others put generated code in
// their own npm packages.
return "google-protobuf/";
}
Equivalent code in grpc-web:
https://github.com/grpc/grpc-web/blob/master/javascript/net/grpc/web/grpc_generator.cc#L461
This will generate something like
import * as google_api_annotations_pb from './google/api/annotations_pb';
import * as google_protobuf_timestamp_pb from 'google-protobuf/google/protobuf/timestamp_pb';
An import option would allow users to explicitly override the relative path and specify a npm package at .proto import could be the right approach to generalize this.
- Dominant language
- JavaScript
- Stars
- 471
- Forks
- 92
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- No contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from protocolbuffers/protobuf-javascript
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
-
Difficulty 5/5 Over a week Newbie friendliness 30/100
protocolbuffers/protobuf-javascript#248 · 1 comment · 13 reactions ·
-
question
Difficulty 3/5 1-2 days Newbie friendliness 45/100
protocolbuffers/protobuf-javascript#222 · 9 comments ·
-
enhancement port-fix triaged
Difficulty 4/5 3-5 days Newbie friendliness 35/100
protocolbuffers/protobuf-javascript#185 · 1 comment ·
-
enhancement port-fix triaged
Difficulty 4/5 3-5 days Newbie friendliness 35/100
protocolbuffers/protobuf-javascript#182 · 3 comments · 1 reaction ·
All issues in protocolbuffers/protobuf-javascript
Similar issues
-
Radix number block generates NaN after switching a negative or decimal number to binary, octal or hexPossibly taken @matthewalberto claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
mit-cml/appinventor-sources#4246 · 1 comment ·
Maintainers usually reply within 1 day
-
marketing
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
accessibility good first issue languages
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
Maintainers usually reply within 2 days
-
bug help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 78/100