Add the option to transpile target files #228
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
smaye81
commented
Sep 14, 2022
smaye81
commented
Sep 16, 2022
smaye81
commented
Sep 21, 2022
timostamm
reviewed
Sep 22, 2022
timostamm
reviewed
Sep 22, 2022
smaye81
changed the title
timostamm
reviewed
Sep 26, 2022
There was a problem hiding this comment.
This looks pretty great to me, just needs a little bit of tidying up, see the two comments below.
Can you remove packages/protoplugin-test/descriptorset.bin and then add it to .gitignore? I know we check in generated source files, but this binary file is not very useful in git.
timostamm
approved these changes
Sep 27, 2022
This was referenced Oct 21, 2022
Merged
smaye81
added a commit
that referenced
this pull request
Oct 25, 2022
This release includes the following: ## 🚨 Breaking Changes 🚨 - #233 - If you have been inspecting fields (`DescField`) from createDescriptorSet(), you will need to update your code to use the new `fieldKind` discriminator. The `kind` property no longer contains values such as `map_field` and `message_field` for their respective types of `DescField`. Instead, a new type has been added named `fieldKind`, which allows you to further identify the kind of field a `DescField` represents (`map`, `enum`, `message`, etc.) - #228 - If you have been using `createEcmaScriptPlugin` to create your own plugin, the signature has changed. Previously, the function accepted a single generator function for generating your output files. This has been split up into separate functions for TypeScript (`generateTs`), JavaScript (`generateJs`), and declaration files (`generateDts`). See the [plugin docs](https://github.com/bufbuild/protobuf-es/blob/main/docs/writing_plugins.md) for more information on usage. ## Enhancements * Add plugin example for creating a Twirp client by @smaye81 #250 * Export printable type by @fubhy #255 * Extend documentation for PlainMessage and PartialMessage by @timostamm #248 * Add convenience functions for retrieving custom options by @smaye81 #244 * Clean up descriptor discrimination by @timostamm #233 * Add a plugin option to keep empty files by @timostamm #229 * Add the option to transpile target files by @smaye81 #228 ## Bugfixes * Fix TypeScript file generation bug by @smaye81 #253 * Fix: arbitrary imports by @fubhy #254 ## New Contributors @fubhy made their first contributions in #254 and #255.
smaye81
added a commit
that referenced
this pull request
Nov 11, 2022
smaye81
added a commit
that referenced
this pull request
Nov 11, 2022
This release includes the following: ## 🚨 Breaking Changes 🚨 - #233 - If you have been inspecting fields (`DescField`) from createDescriptorSet(), you will need to update your code to use the new `fieldKind` discriminator. The `kind` property no longer contains values such as `map_field` and `message_field` for their respective types of `DescField`. Instead, a new type has been added named `fieldKind`, which allows you to further identify the kind of field a `DescField` represents (`map`, `enum`, `message`, etc.) - #228 - If you have been using `createEcmaScriptPlugin` to create your own plugin, the signature has changed. Previously, the function accepted a single generator function for generating your output files. This has been split up into separate functions for TypeScript (`generateTs`), JavaScript (`generateJs`), and declaration files (`generateDts`). See the [plugin docs](https://github.com/bufbuild/protobuf-es/blob/main/docs/writing_plugins.md) for more information on usage. ## Enhancements * Add plugin example for creating a Twirp client by @smaye81 #250 * Export printable type by @fubhy #255 * Extend documentation for PlainMessage and PartialMessage by @timostamm #248 * Add convenience functions for retrieving custom options by @smaye81 #244 * Clean up descriptor discrimination by @timostamm #233 * Add a plugin option to keep empty files by @timostamm #229 * Add the option to transpile target files by @smaye81 #228 ## Bugfixes * Fix TypeScript file generation bug by @smaye81 #253 * Fix: arbitrary imports by @fubhy #254 ## New Contributors @fubhy made their first contributions in #254 and #255.
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.
This adds the ability to transpile generated
.tsfiles into.jsand/or.d.tsfiles. Users can provide the following 3 functions to generate code in their plugin:generateTsgenerateJsgenerateDtsThe
generateTsfunction is required, but the latter two are optional. If one or the other (or both) are not provided, then the framework will auto-transpile the generated TypeScript files to generate the desired code. Note that this is all dependent on the provided target outs. For example, iftarget=jsand nogenerateJsorgenerateDtsis provided, the framework will only transpile JavaScript files (ignoring declaration files). In essence, the framework will only transpile files if needed and even then, will only transpile the ones being requested.It is worth noting that transpilation is an expensive process so if performance is a concern, plugin authors should pass all 3 functions as the plugin code generation process is much faster (
protoc-gen-esuses this approach).When auto-transpiling, the framework uses an older, pinned version of TypeScript for stability (at press time
4.5.2). The compiler options used are intentionally lenient so that the odds of generating code under most circumstances are high. If this is not desirable for plugin authors, they also have the option to provide their owntranspilefunction as part of the plugin initialization configuration. If they provide their own, then thistranspilefunction will be invoked instead and the framework's transpilation process will be bypassed.For an example of implementing a transpiler, see
packages/protoplugin/src/ecmascript/transpile.ts.