feat(next): add Astro.routePattern

[ematipico]

Changes

For Astro 5.0
Closes PLT-2339

It adds a new field to the Astro global called routePattern.

route is RouteData.component without srcDir and pages:

• src/pages/index.astro -> index
• src/pages/blog/[post].astro -> blog/[post]

Testing

I added new tests

Docs

withastro/docs#9180

/cc @withastro/maintainers-docs for feedback!

[changeset-bot]

🦋 Changeset detected

Latest commit: f46dc07

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.

[ascorbic]

Definitely route. Component would be confusing.

[matthewp]

Do we have use-case for this? I'm not against it, just wondering what it's for. I'm assuming it's something Starlight would want?

[ematipico]

@matthewp If you check the linear ticket, Chris left a comment that explains the use case

[florian-lefebvre]

As Chris said, I think it would more useful to have pattern than the component, so /blog/[...slug] instead of src/pages/blog/[...slug].astro

[bluwy]

FWIW the recent astro:route:setup hook exposes a route object with a component property that would be like src/pages/blog/[...slug].astro. I used component because it's also what we (accidentally?) exposed on RouteData, but I don't know of a better name either.

[matthewp]

component is completely legacy name from the very beginning of the project, I think route is fine here personally, it's niche and doubtful we'll regret it later.

[ascorbic]

When I said I thought it should ne route, I was misunderstanding what it was for. If it is just the file, then why not Astro.file? I would expect route to be like @florian-lefebvre said: /blog/[...slug], not src/pages/blog/[...slug].astro

[bluwy]

I actually quite like Astro.file (or Astro.route.file)? Also another data point, for injectRoute() it accepts a pattern option that would look like /blog/[...slug] as well.

[florian-lefebvre]

1. I'd like to know what the value is supposed to be in the following situations:
   a. inside a middleware (looks like it's an empty string?)
   b. after a rewrite (using next)
   c. after a rewrite (using ctx.rewrite)
2. I'm a bit concerned about the name still. I think we may need to add more route related data in the future and it won't scale well (ctx.routePattern, ctx.routeComponent). So maybe we could have ctx.route.pattern instead?

[ematipico]

1. I'd like to know what the value is supposed to be in the following situations:
   a. inside a middleware (looks like it's an empty string?)

It will contain the value of the route you're about to render. I can add more tests if you want.

   b. after a rewrite (using next)

The updated value based on the payload provided to next

   c. after a rewrite (using ctx.rewrite)

The updated value based on the payload provided to rewrite

2. I'm a bit concerned about the name still. I think we may need to add more route related data in the future and it won't scale well (ctx.routePattern, ctx.routeComponent). So maybe we could have ctx.route.pattern instead?

Sounds good

[sarah11918]

Just commenting that I will wait on the docs PR to the API reference page before reviewing the changeset here! 🙌

[florian-lefebvre]

Should the route pattern have a leading slash? like to match RouteData route

[ematipico]

@sarah11918 docs are up

[sarah11918]

@ematipico I know this has already merged, but according to the line in docs about index.* showing only /, is this code comment about what's logged correct? It also includes the file extension here.

We will proofread all the changesets before 5.0 beta release anyway, so I'm not concerned about updating this right now. but I just want to make sure I'm understanding correctly!