Generalize npm dependency support for generated js code

Offen

#47 erstellt am 03.7.2019 5 Kommentare 6 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 5/5
Geschätzter Aufwand: Über eine Woche
Anfängerfreundlichkeit: 32/100

Issue-Typ: Feature
Klarheit: Muss geklärt werden
Aktivitätsstatus: Veraltet
Tech-Stack: cpp, javascript
Bereich: compilers

Rechercherichtung

Beginne damit, javascript/net/grpc/web/grpc_generator.cc rund um die referenzierte Importpfadlogik mit protobufs src/google/protobuf/compiler/js/js_generator.cc zu vergleichen. Bestimme das Verhalten der Importoption und des Paketpfads, das erforderlich ist, um die aktuelle google-protobuf-Ausnahme zu verallgemeinern. Als erledigt gilt die Aufgabe, wenn generierte Imports Abhängigkeiten ausdrücklich aus vom Benutzer angegebenen npm-Paketen auflösen können und relative Imports erhalten bleiben, wenn kein Override angegeben ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

javascript triaged

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.

Vorherrschende Sprache: JavaScript
Sterne: 471
Forks: 91
Ø Merge: 3 Std. 57 Min.
Gemergte PRs (30 T.): 2

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus protocolbuffers/protobuf-javascript

Confusing duplication of libraries - @protocolbuffers/protoc-gen-js and protoc-gen-js Offen

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100

protocolbuffers/protobuf-javascript#287 · Erstellt am 10.9.2026
Support for ES Modules (import/export) in protoc --js_out Offen

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 30/100

protocolbuffers/protobuf-javascript#248 · 1 Kommentar · 13 Reaktionen · Erstellt am 23.9.2025
BUG: Timestamp.toObject() returning zeroed value Offen

question

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 45/100

protocolbuffers/protobuf-javascript#222 · 9 Kommentare · Erstellt am 13.9.2024
Why map.js sort keys? Offen

enhancement port-fix triaged

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 35/100

protocolbuffers/protobuf-javascript#185 · 1 Kommentar · Erstellt am 17.1.2024
Generate alternate accessor for fields with presence Offen

enhancement port-fix triaged

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 35/100

protocolbuffers/protobuf-javascript#182 · 3 Kommentare · 1 Reaktion · Erstellt am 30.12.2023

Alle Issues in protocolbuffers/protobuf-javascript