Added generateId option for file loader

[marceloverdijk]

Background: withastro/roadmap#1045

Changes

• Adds a generateId option to the file loader (similar as the glob loader already has)
• Don't forget a changeset! pnpm exec changeset

Testing

Docs

/cc @withastro/maintainers-docs for feedback!

[changeset-bot]

⚠️ No Changeset found

Latest commit: 3ca422f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

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

[ascorbic]

This is great. Thanks! Could you add a changeset that can form the basis for updated docs?

[marceloverdijk]

Sure will do it later today 👍

[github-actions]

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

[marceloverdijk]

@ascorbic I've added the changeset, is this sufficient?

[ematipico]

Thank you @marceloverdijk for the contribution!

There are three things I ask you to implement:

• Change the changeset to be patch. Content Layer is experimental, so we can land new APIs under patch.
• Create at least a new test to verify that your implementation works. Let me know if you need any help with that. You can start from here

  astro/packages/astro/test/content-layer.test.js

  Line 56 in 7680349

  it('Returns `file()` loader collection', async () => {

• Docs. For now our docs are here:

  astro/packages/astro/src/@types/astro.ts

  Lines 2213 to 2242 in 7680349

  	* The `file()` loader creates multiple entries from a single local file. Use this when all your entries are stored in an array of objects.
  	*
  	* ```ts {3,8,19}
  	* // src/content/config.ts
  	* import { defineCollection, z } from 'astro:content';
  	* import { glob, file } from 'astro/loaders';
  	*
  	* const blog = defineCollection({
  	* // By default the ID is a slug generated from
  	* // the path of the file relative to `base`
  	* loader: glob({ pattern: "**\/*.md", base: "./src/data/blog" }),
  	* schema: z.object({
  	* title: z.string(),
  	* description: z.string(),
  	* pubDate: z.coerce.date(),
  	* updatedDate: z.coerce.date().optional(),
  	* })
  	* });
  	*
  	* const dogs = defineCollection({
  	* // The path is relative to the project root, or an absolute path.
  	* loader: file("src/data/dogs.json"),
  	* schema: z.object({
  	* id: z.string(),
  	* breed: z.string(),
  	* temperament: z.array(z.string()),
  	* }),
  	* });
  	*
  	* export const collections = { blog, dogs };

  . You'll have to provide a new example with the new API

[sarah11918]

Let me know if I can be of any help with docs here! 🙌