Skip to content

feat(vite-plugin): promote build options to experimental - #32

Merged
serhalp merged 5 commits into
mainfrom
claude/solidstart-2-netlify-docs-2l4p0b
Aug 6, 2026
Merged

feat(vite-plugin): promote build options to experimental#32
serhalp merged 5 commits into
mainfrom
claude/solidstart-2-netlify-docs-2l4p0b

Conversation

@serhalp

@serhalp serhalp commented Aug 5, 2026

Copy link
Copy Markdown
Member

Summary

The build options on NetlifyPluginOptions were annotated @private with "DO NOT USE - build options, not meant for public use at this time", and weren't mentioned in the README. This is because it was only used "internally" by @netlify/vite-plugin-tanstack-start, until now.

As this will now be the recommended configuration for SolidStart 2 apps, this PR swaps @private for @experimental and documents the options in the README.

Changes

  • @private -> @experimental and adjust comment.
  • Document in the README.

The `build` options were annotated `@private` with "DO NOT USE", but
they are what SolidStart 2 and TanStack Start projects use to deploy
without a framework-specific adapter. Mark them `@experimental` and
document them in the README so the annotation matches how they're used.

The build implementation isn't TanStack-specific, so update the
supported-frameworks note to include SolidStart 2.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01LSiikE36SgrpS184fepX7Q
@serhalp
serhalp requested a review from a team as a code owner August 5, 2026 15:39
@netlify

netlify Bot commented Aug 5, 2026

Copy link
Copy Markdown

Deploy Preview for angular-runtime-demo ready!

Name Link
🔨 Latest commit 195dafa
🔍 Latest deploy log https://app.netlify.com/projects/angular-runtime-demo/deploys/6a735c1f2a16e20008d8c4a6
😎 Deploy Preview https://deploy-preview-32--angular-runtime-demo.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 141cb7ca-d8da-4c5c-8f7a-60ba51ed7cf1

📥 Commits

Reviewing files that changed from the base of the PR and between fa6d919 and 195dafa.

📒 Files selected for processing (1)
  • packages/vite-plugin/README.md
🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

  • netlify/blueprints (manual)
💤 Files with no reviewable changes (1)
  • packages/vite-plugin/README.md

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Added experimental guidance for building Vite applications for Netlify deployment.
    • Documented build configuration options, including enabling deployment builds and setting custom display names.
    • Added a Vite configuration example for enabling deployment builds.
    • Clarified support for TanStack Start and SolidStart 2 projects.
    • Updated the build option guidance to reflect its experimental availability.

Walkthrough

The Vite plugin documentation now describes experimental build options, deployment preparation, supported frameworks, and configuration usage. The build option JSDoc now uses an experimental disclaimer and lists TanStack Start and SolidStart 2 support.

Estimated code review effort: 1 (Trivial) | ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title directly describes the main change: promoting the build options from @private to @experimental status, which is the core objective of this pull request.
Description check ✅ Passed The description clearly explains the rationale and changes: converting @private to @experimental, adjusting documentation, and supporting SolidStart 2 apps alongside existing TanStack Start usage.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/solidstart-2-netlify-docs-2l4p0b

Comment @coderabbitai help to get the list of available commands.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: a1bc6f11b9

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread packages/vite-plugin/README.md Outdated
Comment thread packages/vite-plugin/src/main.ts Outdated
Comment thread packages/vite-plugin/README.md Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@packages/vite-plugin/README.md`:
- Around line 49-51: Remove the undocumented `build.edgeSSR` option from the
README unless the build implementation is updated to honor it. If retaining the
option, update the build configuration and output path logic so `build.edgeSSR:
true` deploys the SSR handler as a Netlify Edge Function rather than always
writing `.netlify/v1/functions/server.mjs`.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b60bfbca-fa99-4456-ab75-0d3dc07da00d

📥 Commits

Reviewing files that changed from the base of the PR and between c933fa7 and a1bc6f1.

📒 Files selected for processing (2)
  • packages/vite-plugin/README.md
  • packages/vite-plugin/src/main.ts
🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

  • netlify/blueprints (manual)

Comment thread packages/vite-plugin/README.md Outdated
Comment thread packages/vite-plugin/README.md Outdated
@serhalp serhalp changed the title docs(vite-plugin): mark build options experimental instead of private feat(vite-plugin): promote build options to experimental Aug 5, 2026
The suggestion that removed the `build.edgeSSR` bullet replaced only
the first of its two wrapped lines, leaving `Functions` dangling as a
continuation of the `build.enabled` bullet. This failed `prettier
--check`, which wanted to fold it into the line above.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01LSiikE36SgrpS184fepX7Q
@serhalp
serhalp merged commit 566da57 into main Aug 6, 2026
21 of 23 checks passed
@serhalp
serhalp deleted the claude/solidstart-2-netlify-docs-2l4p0b branch August 6, 2026 09:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants