feat: improve extendRoute to have access to the frontmatter

ElMassimo commented 2 years ago

Description 📖

This pull request replaces this fork of vite-plugin-pages with a new @islands/pages module in order to provide a better experience when customizing frontmatter or routes.

The @islands/frontmatter module is now discontinued, and its functionality was moved to @islands/mdx.

Features ✨

extendRoute now has access to route.frontmatter making it possible to customize the path based on frontmatter properties
Can now mutate the frontmatter or route (vite-plugin-pages compares the unextended data which breaks HMR)
Better performance during HMR when changing route data
Faster MDX generation now that the process to inject frontmatter data is unified
extendFrontmatter and extendRoute can now be async

Bug Fixes 🐞

frontmatter.meta.href is now set after all changes to the path, ensuring it's always correct

Breaking Changes 💣

<route> block in SFCs is now <page>, which reflects the fact that it can specify frontmatter
markdown.extendFrontmatter is now at the top level, as extendFrontmatter
pages.extendRoute is now at the top level, as extendRoute
pages.onRoutesGenerated is now at the top level, as extendRoutes

`@islands/pages`

An îles module that provides support for pages, inspired by vite-plugin-pages.

🛣 file-based routing
🎣 hooks to extend frontmatter and route data
📄 adds support for a <page> block in Vue single-file components

  extendFrontmatter (frontmatter, filename) {
    if (filename.includes('/posts/'))
      frontmatter.layout = 'post'
  },
  extendRoute (route) {
    if (route.path.startsWith('/posts'))
      route.path = path.replace(/[\d-]+/, '') // remove date
  },
  extendRoutes (routes) {
    routes.push({ path: '/custom', name: 'Custom', componentFilename: ... }))
  },

extendFrontmatter is very flexible, you could use it to: