feat(nuxt): custom history and routes for app/router.options.ts

[danielroe]

🔗 Linked issue

nuxt/nuxt#14764

❓ Type of change

• 📖 Documentation (updates to the documentation or readme)
• 🐞 Bug fix (a non-breaking change that fixes an issue)
• 👌 Enhancement (improving an existing functionality like performance)
• ✨ New feature (a non-breaking change that adds functionality)
• ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

Alongside first-class 'presets' like nuxt/nuxt#14764 and nuxt/nuxt#13821 which can be configured with a string, it might be useful to allow fully overriding router history + routes for advanced use cases (= escape hatch).

This allows a router options something like this:

import type { RouterConfig } from '@nuxt/schema'
import { createMemoryHistory } from 'vue-router'

export default <RouterConfig> {
  history: process.client ? createMemoryHistory : undefined
}

Note that this does not replace #6980 as hash history has its own challenges with an SSR framework and needs its own implementation.

📝 Checklist

• I have linked an issue or discussion.
• I have updated the documentation accordingly.

[netlify]

✅ Deploy Preview for nuxt3-docs ready!

Name	Link
🔨 Latest commit	4fc9305
🔍 Latest deploy log	https://app.netlify.com/sites/nuxt3-docs/deploys/631456a55cc42c0009359839
😎 Deploy Preview	https://deploy-preview-7129--nuxt3-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site settings.

[pi0]

I like the idea of being able to override history and routes via app/router.options file.

The factory function for history seems good idea too.

Maybe we can also pass default routes to a factory to allow overriding+modifiying routes from config?

(in both regards delaying this PR as well as history for after RC.9 to test better)

[danielroe]

Great. Can look into factory routes option as well 👍

Big question in my mind (regardless of the factory function point) is tree-shaking - would be nice to support tree-shaking out auto-generated routes in the event that user fully overrides them, and I'm not sure that rollup will remove them from the build as is. (But then again, nothing stopping user from removing them entirely in the pages:extend hook so maybe I'm overthinking this.)

[pi0]

Agreed that hook is probably best way to override routes. Do you mind adding function support for routes() in order to merge this?