Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

standardize on Greenwood config as single source for prerender behavior for all renderer plugins #1343

Closed
thescientist13 opened this issue Dec 13, 2024 · 0 comments · Fixed by #1344
Assignees
Labels
alpha.2 breaking CLI Content as Data documentation Greenwood specific docs enhancement Improve something existing (e.g. no docs, new APIs, etc) Plugins Greenwood Plugins SSR v0.31.0
Milestone

Comments

@thescientist13
Copy link
Member

thescientist13 commented Dec 13, 2024

Type of Change

Enhancement

Summary

Coming out of conversations in #1170 , it was questioned what the Lit SSR plugin's prerender configuration offers, since it is somewhat presented as an alternative to Greenwood's default WCC powered SSR renderer. However, at this time, the Lit SSR plugin doesn't really distinguish pages using Lit from those not using Lit and so only understands LitElemeent anyway, so I don't think there's anything achieved with having two options for the same thing, since it doesn't achieve any meaningful behavior / value.

In fact, on the Lit SSR website docs page, we demonstrate just using the top-level prerender option in greenwood.config.js
Screenshot 2024-12-13 at 12 14 47 PM

Details

So I think it would make sense that for renderer plugins they should also mirror this behavior, so we might as well just use the value of prerender from greenwood.config.js and Renderer plugins can just leverage that to manage their behavior.

We'll also want to update the website docs for this Plugin API - https://greenwoodjs.dev/docs/reference/plugins-api/#renderer

@thescientist13 thescientist13 added this to the 1.0 milestone Dec 13, 2024
@thescientist13 thescientist13 self-assigned this Dec 13, 2024
@thescientist13 thescientist13 changed the title remove prerender option from Lit SSR plugin remove prerender config option from Lit SSR plugin Dec 13, 2024
@thescientist13 thescientist13 changed the title remove prerender config option from Lit SSR plugin standardize on Greenwood config as single source for prerender behavior for all renderer plugins Dec 13, 2024
@thescientist13 thescientist13 added Content as Data enhancement Improve something existing (e.g. no docs, new APIs, etc) labels Dec 13, 2024
@thescientist13 thescientist13 moved this from 🔖 Ready to 🏗 In progress in [Greenwood] Phase 10 - Ecosystem Compat Dec 13, 2024
@thescientist13 thescientist13 moved this from 🏗 In progress to 👀 In review in [Greenwood] Phase 10 - Ecosystem Compat Dec 13, 2024
@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Done in [Greenwood] Phase 10 - Ecosystem Compat Dec 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
alpha.2 breaking CLI Content as Data documentation Greenwood specific docs enhancement Improve something existing (e.g. no docs, new APIs, etc) Plugins Greenwood Plugins SSR v0.31.0
Projects
1 participant