Currently, the types for astro-pages break in larger projects like astro-theme-provider and @astrolicious/i18n but seems works in brand new empty projects. For some reason, the types on the function signatures is any but importing the types and casting them manually works. Why is this happening?

Currently, if a file:// path gets passed the package assumes that the path is a file and turns it into a directory, but file:// paths can be directories too. This function should check whether or not the file:// path is a file before using dirname() on it to get the directory

https://github.com/BryceRussell/astro-pages/blob/main/package/utils/add-page-dir.ts#L22

Currently the API for integrations looks like this:

const {
  patterns,
  entrypoints,
  injectPages()
} = addPageDir({...})

injectPages()

The problem with this API is that entrypoints is not a live array, if the patterns object is updated it will not be reflected inside entrypoints. Instead we should encourage the user to use Object.values(patterns) to compile an array of entrypoints from the live pattern reference.

Another tweak that could be made is renaming patterns to routes or pages. patterns is an object of pattern keys and entrypoint values so it would make since to rename this something more semantically correct

Also need to document manipulating the patterns object to add/remvoe pages

Future

Maybe adding utilities like addPage or removePage, although this can already be done fairly easily by manipulating the patterns object.

In Astro's page directory you can exclude a file/folder by appending underscore _ to the name: https://docs.astro.build/en/guides/routing/#excluding-pages Although astro-pages allows you to ignore routes using globs, astro-pages should also follow Astro's standard and ignore routes prefixed with an underscore _

Some Astro integrations will throw errors if astro-pages is located after the integration.

To do:

1. Explore compatibility by downloading Astro integrations and testing them before/after astro-pages in the integrations array
2. If an integration throws errors when using astro-pages:
   • Add a check using hasIntegration
   • Or, comment here for someone else to add

Reported incompatibilities:

• astro-pages after @storyblok/astro

In Astro v4.0, the entryPoint property for the injectRoute option was renamed to entrypoint (lowercase p):
https://docs.astro.build/en/guides/upgrade-to/v4/#renamed-entrypoint-integrations-api

Currently astro-pages only uses the property entrypoint but could also add the property entryPoint to support v3.0

   injectRoute({
+   entryPoint: entrypoint,
    entrypoint,
    pattern
   })

Astro is easy to upgrade and users should always be using the latest version but in some cases a project might be "stuck" in an older version so there is no reason to not support this since it is a non-breaking change

Currently, astro-pages will check if the dir or cwd options are pointing to Astro's page dir and throw an error. It would be nice if this check was moved or deferred to the injectPages function so that users can still read/parse Astro's page dir into a page object but when they try to inject it will throw an error.

Currently, when using the standalone utility, you have to pass the injectRoute function as argument to addPageDir:

const pageConfig = {
  dir: 'pages',
  config,
  logger,
  injectRoute
}

const { 
  pages,
  injectPages 
} = addPageDir(pageConfig)

injectPages()

But in some cases a user might only want to access the pages object and NOT inject the pages so it would make more sense if injectRoute was an argument for injectPages instead of addPageDir:

const pageConfig = {
  dir: 'pages',
  config,
  logger
}

const { 
  pages,
  injectPages 
} = addPageDir(pageConfig)

injectPages(injectRoute)

Would be great to update the format of pages to be an InjectedRoute, including prerender. I guess it requires reading each file and some regex work