Added support for cjs output #303
Merged
Conversation
This file contains 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
timostamm
approved these changes
Dec 14, 2023
Merged
paul-sachs
added a commit
that referenced
this pull request
Dec 14, 2023
## What's Changed * Update imports to include file extensions by @paul-sachs in #299 and #307 * Added support for cjs output by @paul-sachs in #303 * Loosen peer dependency requirement by @paul-sachs in #306 ## CJS output By default, [protoc-gen-connect-query](https://www.npmjs.com/package/@connectrpc/protoc-gen-connect-query) (and all other plugins based on [@bufbuild/protoplugin](https://www.npmjs.com/package/@bufbuild/protoplugin)) generate ECMAScript `import` and `export` statements. For use cases where CommonJS is difficult to avoid, a new plugin option has been added named `js_import_style` which can be used to generate CommonJS `require()` calls. Here is an example [buf.gen.yaml](https://buf.build/docs/configuration/v1/buf-gen-yaml): ```yaml version: v1 plugins: # You'll need @bufbuild/protoc-gen-es v1.6.0 or later - plugin: es out: src/gen opt: js_import_style=legacy_commonjs - plugin: protoc-gen-connect-query out: src/gen opt: js_import_style=legacy_commonjs ``` To view the full PR, see **Added support for cjs output** by @paul-sachs in #303 **Full Changelog**: v1.0.0...v1.1.0
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.
Fixes #297
Add support for CommonJS with the new plugin option:
js_import_styleBy default, protoc-gen-connect-query(and all other plugins based on @bufbuild/protoplugin) generate ECMAScript
importandexportstatements. For use cases where CommonJS is difficult to avoid, this option can be used to generate CommonJSrequire()calls.Example buf.gen.yaml