TypeScript imports broken since use of ProtoScript

Question

TypeScript imports broken since use of ProtoScript

zolex opened this issue 2 years ago · comments

since version 0.0.61 when ProtoScript is used by twirpscript to generate typescript code, the imports of the messages from the services are broken:

it outputs .pb.ts files but the import statements are .pb.js

generated files:

import statements before 0.0.61

import statements since 0.0.61

Tate Thurston · Answer 1 · Sat Sep 24 2022 01:57:03 GMT+0800 (China Standard Time)

@zolex Thanks for reporting this. This change is intentional, and was made specifically to support the TypeScript compiler. The full extension path is expected — it’s required for ES modules which don’t implicitly assume a js extension like commonjs does. The TypeScripts compiler expects js extensions and not ts extensions because the compiler does not manipulate import paths: https://www.typescriptlang.org/docs/handbook/esm-node.html. The TypeScript team may reevaluate this in 4.9.

I suspect you're using something other than the TypeScript compiler, such as webpack and ts-loader, to compile your TypeScript code? TypeStrong/ts-loader#1383.

@andrewbeckman ran into this as well and reported it in #192. Given this rough edge, I'm open to reevaluating this.

Tate Thurston · Answer 2 · Sat Sep 24 2022 02:01:25 GMT+0800 (China Standard Time)

This could look like the following:

Continue to use full import paths for JS. This delivers correct ESM for browser and node runtimes.
Drop the .js extension for TS. Browser builds like webpack accept ESM without the full extension, so this would only prevent users from running TwirpScript server side as ESM (type: "module" in package.json). I suspect this is an acceptable tradeoff until the TS team better aligns with the rest of the JS ecosystem, and I can expose a config option for the current behavior if anyone requests it.

Andreas Linden · Answer 3 · Sat Sep 24 2022 04:55:14 GMT+0800 (China Standard Time)

That's interesting, thanks for the detailed answer.

Our Frontend team is using gatsby, do you know how to address this issue here?

Tate Thurston · Answer 4 · Sat Sep 24 2022 05:07:15 GMT+0800 (China Standard Time)

@zolex I've published https://github.com/tatethurston/TwirpScript/releases/tag/v0.0.64 with the changes I mentioned above. This should "just work" for you -- let me know if you encounter any issues.

Andreas Linden · Answer 5 · Sat Sep 24 2022 05:44:19 GMT+0800 (China Standard Time)

Thanks man, I'll ask our responsible dev on monday to see if it solves the issues.