feat: allow typescript compilation of nuxt.config

[danielroe]

This PR allows typescript compilation of nuxt.config.ts, as well as serverMiddleware and local modules. When using this approach, @nuxt/typescript-runtime should only be required at build-time.

Rendered docs

TODO:

• Create tests
• Add documentation

[kevinmarrec]

@danielroe Could you resolve conflicts ? Also what exactly did you succeed to achieve for now ?

[danielroe]

@kevinmarrec I've edited the PR description explaining what it can currently do.

[danielroe]

@kevinmarrec Okay, I've added tests and docs and think this is now ready for you to look at.

[HunderlineK]

Hey, I was following the guide for support typescript with serverMiddleware by using nuxt-ts generate but from this feature request it seems typescript for serverMiddleware for production is not supported yet?

I'm running into a bunch of syntax errors with nuxt-ts generate, but I suppose if the feature is not supported, those errors are also expected?

[HunderlineK]

So I solved my issue, in a way! I didn't manage to make typescript compiling work, but simply enabling the options "allowJs": true, and "checkJs": true provides you with errors in your editor (I use VS Code) even if the file extension is js. Then, you can just start typing your code using jsdoc and define your more complex types in a .d.ts file (I have multiple of those files for different domains in my app).

An advantage of defining types in a '.d.ts' file is that you can share them between your APIs and front end!

I am impressed by how great interoperability between jsdoc and typescript is; I have yet to come to a situation where I want to specify a certain type in jsdoc and I can't.

Having used this for a production app, I think this is even better than writing typescript files, because 1. you don't have to worry about any kind of compiling issues 2. your codebase remains clean JavaScript and 3. I find jsdocs to be necessary for certain functions and methods anyways

Hope it helps!

[TroyKomodo]

Is this dead?

[pi0]

Starting with nuxt@2.15 we use jiti instead of esm as require engine which supports typescript-runtime out of the box.