Skip generating wrangler types when building for deployment

[teemingc]

The current Cloudflare adapter template adds wrangler types to the prepare npm lifecycle script but types are not necessary for deployments. Is it worth finding a way to skip this step in CI and making that change?

cc: @ghostdevv

[jycouet]

Today we have:

"prepare": "pnpm run types && svelte-kit sync || echo ''",

1/ We should not use pnpm but npm.

2/ To answer your question, we could move the types generation in dev AND build ?

[teemingc]

I think we only need it for type checking so it could be moved to the check script

EDIT: thinking about it more, we really want to avoid overrunning this. The types would only change when certain fields are changed in the wrangler config which is not very often

[jycouet]

I find it strange to generate something in a script called check.

We can also just add it to next steps and remove it from prepare?
Something like:

• It's teaching people that they need to run it again...

[ghostdevv]

Only just seeing this unfortunately - moving it out of prepare is tricky because it's gitignored, which then means that when you setup a project you have to both know and remember to run the generate script. I think this is a place we're different from what create-cloudflare does, as they do gitignore it - but personally I'm not a big fan of committing generated files. It does feel like a rock and hard place situation though, since it's not a super fast command (1-3s on my system). They did add a --check flag recently so you know if it's stale, but it takes the same amount of time to run as just outputting the types 🫠

[teemingc]

Do you know if there’s a solution that could be better than the CLI reminding the user to run it manually?

There’s also an issue where you will get type errors after generating the types if you have a wrangler config referencing the generated worker script because it’s not typed

[jycouet]

Maybe a bit too fast !
If we go back to the original issue... Is it a problem to have it generating types we deploying ?!
Maybe going back to the original way by default is not that bad ?

[ghostdevv]

There’s also an issue where you will get type errors after generating the types if you have a wrangler config referencing the generated worker script because it’s not typed

Do you have an example of what you mean?

Is it a problem to have it generating types we deploying ?!

It just makes the build 1-3s slower

[teemingc]

There’s also an issue where you will get type errors after generating the types if you have a wrangler config referencing the generated worker script because it’s not typed

Do you have an example of what you mean?

Currently, we require specifying the sveltekit worker in the wrangler config

	"main": ".svelte-kit/cloudflare/_worker.js",

But that isn't typed. Generating the worker types results in a worker type file such as:

declare namespace Cloudflare {
	interface GlobalProps {
		mainModule: typeof import("./.svelte-kit/cloudflare/_worker");
	}
	interface Env {
		// ...
	}
}

And this will fail type checking because of the type errors in that worker file

[teemingc]

Re-opening this so we can remember to come to one of these two decisions and fix their related issues:

1. Don't automatically generate types

   • remove the generated type file from gitignore

2. Automatically generate types

   • ensure the worker file has no type errors

[sacrosanctic]

Would something like this help.

https://bsky.app/profile/esm.dev/post/3mhif45frkd2u

[jycouet]

I would like to get input from daily user of this platform, to go the correct way.
We can do a lot technically, but doing the right thing is the best!

May I ping @ghostdevv for any suggestion here?