Add gentypeconfig.moduleResolution options: node16 and bundler for better interop with TS+ESM projects

[cometkim]

Resolves #6003

This introduces a new gentype option moduleResolution. This makes it able to customize the artifacts module imports strategy customizable, so it provides compatibility with the compilerOptions.moduleResolution setting in TypeScript projects.

With moduleResolution:

• node (default): Drop extensions in import paths. This doesn't change any behavior.
• node16: Use TS output's extension. This provides compatibility with projects using moduleResolution: node16 and ESM.
• bundler: Use TS input's extension. This provides compatibility with projects using moduleResolution: bundler and ESM. This also requires TS v5.0+ and compilerOptions.allowImportingTsExtensions to true

[cristianoc]

I had a first quick look, and everything looks fine. Will read in more detail later.
There are questions about adding new tests.

[cristianoc]

Also, the changelog needs updating.

[cristianoc]

First round of complete review.
Left some comments, but it all seems good.
Todo still remove the additional projects unless they bring some value in which case they can stay.

[cristianoc]

Why ".e.g"? Isn't it exactly .gen.js?

[cometkim]

uhhh if I'm guessing right, the output of GenType is always .gen.ts or .gen.tsx and can't be customized with a different extension?

[cristianoc]

let inputFileSuffix ~(config : Config.t) =
  match config.generatedFileExtension with
  | Some s when Filename.extension s <> "" (* double extension  *) -> s
  | _ -> generatedFilesExtension ~config ^ ".tsx"

[cristianoc]

In this code, I don't understand the naming of the functions:

let generatedModuleExtension ~(config : Config.t) =
  match config.moduleResolution with
  | Node -> generatedFilesExtension ~config
  | Node16 -> outputFileSuffix ~config
  | Bundler -> inputFileSuffix ~config

One is "input" one is "output" etc. Seems confusing.
Is there a more intuitive renaming?

[cristianoc]

There's a multiplication of concepts here:

• node, node16, bundler
• input, output
• .js, .tsx

Feels like one has to keep all those in their head to understand what this does.

[cristianoc]

That sounds good

[cristianoc]

About the "e.g." I think it should be removed. If it's not always exactly that, say what config determines the extension and how, instead of "e.g.".

[cristianoc]

So we have the right sentences to use for the documentation website already.

[cometkim]

Note:

TS bundler moduleResolution means "hybrid". Whether it has no extension, .ts or .js, its resolution depends on the user's build tool (bundler)

Compatible with most bundlers, the most naive way to implement this is to specify the input filename exactly. Therefore, no implicit extension inference takes place.

See microsoft/TypeScript#51669

[cristianoc]

What I mean is, the behaviour of genType should be specified precisely. That's all.

[cristianoc]

This looks ready to merge.
Anything missing?

[cometkim]

Ready to merge

[cristianoc]

Ready to merge

Fantastic.
Awesome contribution.

[cometkim]

Thank you for the detailed review 😁