Skip to content

refactor: Make 'vite-prerender-plugin' optional #184

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.

Sign up for GitHub

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

Draft
rschristian wants to merge 3 commits into
base: v3
Choose a base branch
from
+75 −37
Draft

refactor: Make 'vite-prerender-plugin' optional #184

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
db1352e
refactor: Make 'vite-prerender-plugin' optional
rschristian Mar 10, 2026
b9ac20f
refactor: Remove conditional middleware plugin
rschristian Mar 10, 2026
b6c5bef
refactor: Load prerender plugin conditionally
rschristian Mar 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 58 additions & 22 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 9 additions & 3 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,17 @@
"debug": "^4.4.3",
"magic-string": "^0.30.21",
"picocolors": "^1.1.1",
"vite-prerender-plugin": "^0.5.12",
"zimmerframe": "^1.1.4"
},
"peerDependencies": {
"@babel/core": "7.x",
"vite": "7.x"
"vite": "7.x",
"vite-prerender-plugin": "*"
},
"peerDependenciesMeta": {
"vite-prerender-plugin": {
"optional": true
}
},
"devDependencies": {
"@babel/core": "^7.28.5",
Expand All @@ -61,7 +66,8 @@
"prettier": "^2.2.1",
"simple-git-hooks": "^2.13.1",
"typescript": "^5.9.3",
"vite": "^7.2.2"
"vite": "^7.2.2",
"vite-prerender-plugin": "^0.5.12"
},
"nano-staged": {
"**/*.{js,jsx,ts,tsx,yml,json}": [
Expand Down
20 changes: 8 additions & 12 deletions src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import prefresh from "@prefresh/vite";
import { createFilter } from "@rollup/pluginutils";
import { vitePrerenderPlugin } from "vite-prerender-plugin";
import { transformAsync } from "@babel/core";
// @ts-ignore package doesn't ship with declaration files
import babelReactJsx from "@babel/plugin-transform-react-jsx";
Expand All @@ -14,9 +13,16 @@ import { parseId } from "./utils.js";

/** @import { Plugin, ResolvedConfig } from "vite"; */
/** @import { ParserPlugin } from "@babel/parser"; */
/** @import { Options as PrerenderPluginOptions } from "vite-prerender-plugin" */

/** @import { preact as PreactPlugin, PreactBabelOptions } from "./index.d.ts" */

/** @type {(options?: PrerenderPluginOptions) => Plugin[]} */
let vitePrerenderPlugin;
try {
({ vitePrerenderPlugin } = await import("vite-prerender-plugin"));
} catch {}

/**
* Taken from https://github.com/vitejs/vite/blob/main/packages/plugin-react/src/index.ts
*
Expand Down Expand Up @@ -62,16 +68,6 @@ function preactPlugin({
reactAliasesEnabled = reactAliasesEnabled ?? true;
prerender = prerender ?? { enabled: false };

const prerenderPlugin = vitePrerenderPlugin(prerender);
if (!prerender.previewMiddlewareEnabled) {
const idx = prerenderPlugin.findIndex(
p => p.name == "serve-prerendered-html",
);
if (idx > -1) {
prerenderPlugin.splice(idx, 1);
}
}

Comment on lines -66 to -74
Copy link
Member Author

@rschristian rschristian Mar 10, 2026

Choose a reason for hiding this comment

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

Vite's preview server routes everything back to index.html, which is a problem when testing prerendered apps as few people are actually using paths like /foo.html to navigate.

I added a plugin years ago to help with this but cautiously made it opt-in here to avoid any potential for breaking changes. We can remove this now, IMO.

/** @type {Plugin} */
const jsxPlugin = {
name: "vite:preact-jsx",
Expand Down Expand Up @@ -210,7 +206,7 @@ function preactPlugin({
...(prefreshEnabled
? [prefresh({ include, exclude, parserPlugins: baseParserOptions })]
: []),
...(prerender.enabled ? prerenderPlugin : []),
...(prerender.enabled ? vitePrerenderPlugin(prerender) : []),
];
}

Expand Down
Loading