Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add FAQ for parcel/metro #955

Merged
merged 2 commits into from
Aug 1, 2024
Merged

Add FAQ for parcel/metro #955

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ce66364
Add FAQ for parcel/metro
timostamm Aug 1, 2024
6103586
Merge remote-tracking branch 'origin/main' into tstamm/Add-FAQ-for-pa…
timostamm Aug 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions MANUAL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2428,6 +2428,21 @@ This isn't to say that we're completely against adding _any_ options to the plug
adding an option is necessary. However, for cases such as stylistic choices or user preferences, we tend to err on the
side of caution.

### Parcel/Metro fails to resolve imports

Protobuf-ES uses [package exports][package.json/exports]. If you see the following error with [Parcel], make sure to
[enable package exports][parcel/exports]:

```
@parcel/core: Failed to resolve '@bufbuild/protobuf/codegenv1'
```

If you see the following error with [Metro] or [Expo], make sure to [enable package exports][metro/exports]:

```
Metro error: Unable to resolve module @bufbuild/protobuf/codegenv1
```

[@bufbuild/buf]: https://www.npmjs.com/package/@bufbuild/buf
[@bufbuild/protobuf]: https://www.npmjs.com/package/@bufbuild/protobuf
[@bufbuild/protoc-gen-es]: https://www.npmjs.com/package/@bufbuild/protoc-gen-es
Expand All @@ -2452,11 +2467,17 @@ side of caution.
[custom-options]: https://protobuf.dev/programming-guides/proto3/#customoptions
[ecmascript-modules]: https://www.typescriptlang.org/docs/handbook/esm-node.html
[example.proto]: ./packages/protobuf-example/proto/example.proto
[expo]: https://github.com/expo/expo
[gh-buf-conformance]: https://github.com/bufbuild/protobuf-conformance
[gh-connect-es]: https://github.com/connectrpc/connect-es
[gh-protoc]: https://github.com/protocolbuffers/protobuf/releases
[gh-zod]: https://github.com/colinhacks/zod
[metro]: https://github.com/facebook/metro
[metro/exports]: https://metrobundler.dev/docs/package-exports
[package.json/bin]: https://docs.npmjs.com/cli/v10/configuring-npm/package-json#bin
[package.json/exports]: https://nodejs.org/docs/latest-v12.x/api/packages.html#packages_exports
[parcel]: https://github.com/parcel-bundler/parcel
[parcel/exports]: https://parceljs.org/features/dependency-resolution/#package-exports
[google/protobuf/any.proto]: https://github.com/protocolbuffers/protobuf/blob/v27.2/src/google/protobuf/any.proto
[google/protobuf/api.proto]: https://github.com/protocolbuffers/protobuf/blob/v27.2/src/google/protobuf/api.proto
[google/protobuf/compiler/plugin.proto]: https://github.com/protocolbuffers/protobuf/blob/v27.2/src/google/protobuf/compiler/plugin.proto
Expand Down