[Content collections] Move generated types to .astro directory

[bholmesdev]

Changes

• Moves generated types from src/content/types.generated.d.ts -> .astro/types.d.ts
• Generate a src/env.d.ts if none exists with the astro/client and .astro types
• Add .astro reference path to src/env.d.ts if one already exists

Why move types.generated?

Outputting generated types inside src/ has some drawbacks:

• Linters and prettier will try to format the file. This has lead to issues in our CI already, as the type generator may not respect your indentation rules.
• Putting generated types alongside your content can be confusing. We've already received support forum requests asking whether to ignore the file. By consolidating all generated types to .astro, we can have future-proof recommendations there!

Testing

• astro check on updated @examples/with-content
• check that writeFile is called on the env.d.ts file during astro sync

Docs

withastro/docs#2313

[changeset-bot]

🦋 Changeset detected

Latest commit: 4984511

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[github-actions]

This PR is blocked because it contains a minor changeset. A reviewer will merge this at the next release if approved.

[matthewp]

Does this mean you don't get types without manually creating a file? Or was this already required? Is there anything we can do about that?

[bholmesdev]

This will be automatically generated if a src/env.d.ts is present! Otherwise, we assume you've deleted or moved this file to manage ambient types yourself. Since this file is home to the astro/client types, I'd assume most users have this file in their Astro project.

[fflaten]

Any reason this couldn't be in node_modules/.astro like the generated image cache? Just curious. 🙂

With astro sync available I'm unsure why we'd want to commit it anymore.

[github-actions]

This PR is blocked because it contains a minor changeset. A reviewer will merge this at the next release if approved.

[bholmesdev]

Fair question @fflaten! There's a couple reasons for it:

1. To stay consistent with existing frameworks that use generated types, namely Nuxt and SvelteKit.
2. To ensure editor tooling keeps up with your edits. Types in node_modules are cached by editors like VS Code, so you'd need to restart your TS server periodically while working in dev.

That second reason definitely pushed us to types in your project root. Luckily, .astro/ will be the landing place for any generated code in the future, making it easy to gitignore.

[fflaten]

Thanks. Just not used to have generated data (cache) in a config-folder, but I agree the second reason alone is a good enough reason. 👍

[github-actions]

This PR is blocked because it contains a minor changeset. A reviewer will merge this at the next release if approved.

[github-actions]

This PR is blocked because it contains a minor changeset. A reviewer will merge this at the next release if approved.

[github-actions]

This PR is blocked because it contains a minor changeset. A reviewer will merge this at the next release if approved.

[github-actions]

This PR is blocked because it contains a minor changeset. A reviewer will merge this at the next release if approved.

[natemoo-re]

Code LGTM, small comment about simplifying the .gitignore

[github-actions]

This PR is blocked because it contains a minor changeset. A reviewer will merge this at the next release if approved.

LGTM

[github-actions]

This PR is blocked because it contains a minor changeset. A reviewer will merge this at the next release if approved.

ugh