feat: restart server with overwritten configuration

[CHOYSEN]

Description

Provide a programming way to modify configuration like base/port.

Additional context

HAS BREAKING CHANGE!

Remove the forceOptimize arg, so user need manually pass { server: { force: true } } to keep the previous behavior

---

What is the purpose of this pull request?

• Bug fix
• New Feature
• Documentation update
• Other

Before submitting the PR, please make sure you do the following

• Read the Contributing Guidelines.
• Read the Pull Request Guidelines and follow the Commit Convention.
• Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
• Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
• Ideally, include relevant tests that fail without this PR but pass with it.

[netlify]

✅ Deploy Preview for vite-docs-main ready!

Name	Link
🔨 Latest commit	a1b6050
🔍 Latest deploy log	https://app.netlify.com/sites/vite-docs-main/deploys/62b5c81214412e00089e920d
😎 Deploy Preview	https://deploy-preview-8766--vite-docs-main.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.

[bluwy]

Is there an example of a usecase for restarting with a different base / port? forceOptimize was initially added for vite-plugin-svelte's prebundleSvelteLibraries option (IIRC), but we don't use it now as there's a different way of handling it. And I'm not sure if there's anyone else using it 🤔

[CHOYSEN]

Vitepress allow user write their config, and then listening the config change.

Though i can write the following code to modify base and restart server, but it will be better to provide a explicit way.

server.config.inlineConfig.base = newData.base
await server.restart()

[bluwy]

Shouldn't restarting the server would re-run all plugins which can then set the new base option? So perhaps for this code we can have the vitepress plugin set the base root etc in the config hook which should fix the issue. Otherwise, it'd have to restart the wrapping vitepress server instead.

While I think we're working around this when it can be as simple as the proposed solution in the PR, I think it would be better in the long run when more plugins call restart themselves, and we don't have these temporary state potentially dangling.

[CHOYSEN]

Thanks for your reply, i agree with you that plugin should use the config hook to overwrite config. And do you think we should remove forceOptimize(as a breaking change in V3)?

[bluwy]

And do you think we should remove forceOptimize(as a breaking change in V3)?

I think we could leave it in for awhile if someone is actually using it. The other way of handling things may not be as straightforward for them, but until we have something like server.queueOptimizerRerun or similar, I think then we can remove it. That way we can call the function anywhere we like, instead of only when restarting the server.