feat: add prerender:config, prerender:init and prerender:done hooks

[harlan-zw]

🔗 Linked issue

Related nuxt/nuxt#22255

❓ Type of change

• 📖 Documentation (updates to the documentation, readme, or JSdoc annotations)
• 🐞 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)
• 🧹 Chore (updates to the build process or auxiliary tools and libraries)
• ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

An initial step to giving greater prerendering powers to integrations.

Some examples of what this unblocks:

• emit manifests using data collected during the prerender stage
• improved error reporting for routes that fail
• stubbing in modules that are only for the prerender stage

Out of scope of this PR but still to do be done:

• Close the Prerenderer when it finishes processing all routes
• Prenderer API exposed on hooks (generateRoute, queueFinished, etc)

📝 Checklist

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

[codecov]

Codecov Report

Merging #1519 (1e638bc) into main (30b3578) will decrease coverage by 0.01%.
Report is 1 commits behind head on main.
The diff coverage is 96.42%.

@@            Coverage Diff             @@
##             main    #1519      +/-   ##
==========================================
- Coverage   76.23%   76.23%   -0.01%     
==========================================
  Files          73       73              
  Lines        7524     7540      +16     
  Branches      739      738       -1     
==========================================
+ Hits         5736     5748      +12     
- Misses       1787     1790       +3     
- Partials        1        2       +1     

Files Changed	Coverage Δ
src/prerender.ts	85.17% <94.11%> (+0.30%)	⬆️
src/types/nitro.ts	100.00% <100.00%> (ø)

... and 1 file with indirect coverage changes

[danielroe]

Beautiful feature idea. I agree with @pi0's comment, but otherwise 👌

[Hebilicious]

I love it!
Regarding the hook names, we use the before/done terminology for modules and build, should we use this as a convention ? Or maybe define a new one such as init/finished or before/start ?

[harlan-zw]

Yes closing seems a good idea (it will automatically call close hook afterwards). The hook before should be something like done

Should I make a separate PR for this or include it here?

[pi0]

LGTM 💯 (have to fix failing ci, it needs parent dir creation)

[harlan-zw]

LGTM 100 (have to fix failing ci, it needs parent dir creation)

To fix the test properly it would need access to the main nitro instance (not the prerenderer) for the preset output directories 🤔 A native nitro:init hook that exposes the nitro instance would be a way to solve this without having to add the nitro instance to every hook.

For now, I just removed the test.

[pi0]

Thanks again for the PR. I have pushed some relevant refactors on top of it hope it is all fine to you.

[harlan-zw]

Perfect, thank you. I'll think about the prerender controller and if I find some free time and it hasn't been attempted yet, will give it a go.