Remove injected route

[feelixe]

Body

Summary

In the Integration API's hook astro:config:setup, I want to suggest adding a function to remove an injected route.

Background & Motivation

As an integration author it is currently not possible to remove an injected route without restarting the server an then not injecting it.

Why would someone need to remove an injected route?
If an injected route is dependant on files in the user's project you might want to do this.

Goals

• Improve the integration API by allowing integration authors to remove routes without requiring the user to restart the server.

Example

I would suggest either of the following APIs. I'm not familiar with the inner workings of Astro, so I'm not sure if they are viable.

Option 1:
Add a function to the options of astro:config:setup. I haven't tested if pattern is unique for injected routes, this might be problematic if it isn't.

{
  removeInjectedRoute: (args: { pattern: string }) => void;
}

Option 2:
Add a return value to injectRoute that removes the route.
I think this API would be less useable, and I only provide it as an option if it's more viable.

{
   injectRoute: (injectedRoute: InjectedRoute) => { remove: () => void };
}

[florian-lefebvre]

I'm not convinced by this proposal, I think your problem could be solved by collecting these files via watchFile. Could you provide a minimal reproduction showcasing your problem? I'd like to have a look

[feelixe]

I guess addWatchFile would solve the problem. But it feels like kind off a misuse of the api in my opinon. Server shouldn't have to be restarted just for removing a route right?

Let's take this as an example, you have these routes in your project:

pages/
  index.astro
  about.astro

And you have an integration that will automatically add localized routes via injectRoute:

/sv-se/
/sv-se/about

If you add a new route, the integration can call injectRoute which works fine.
But if you remove a route, you would have to restart the server.

Using addWatchFile would mean adding all your routes which would probably not be ideal.

edit, maybe not the best example, because you would probably use [locale] in the route instead.
My use case is have .tsx files directly in pages that gets added as routes, so I don't need a .astro file that is just a wrapper.

[florian-lefebvre]

Maybe a dumb question but why do you need to inject several routes? Couldn't you inject 1 catch-all route and return different stuff from getStaticPaths depending on the users files?

[feelixe]

Yeah, thats a good point! Hadn't thought about that. I'll close this, probably an edge case to need this.

[florian-lefebvre]

If you still find the need for a change in core, revive this!